CKEditor Braille
This module integrates CKEditor 5 with a Braille input plugin, enabling users to type Braille characters using keyboard shortcuts. It also allows for transliteration between regular text and Braille, offers configuration options for widget instances, and includes speech synthesis for reading content.
A Drupal module that integrates CKEditor 5 with a Braille input plugin, allowing users to type Braille unicode characters directly inside the editor using standard keyboard key combinations.
Features
- Braille widget insertion with configurable key mappings
(f d s j k l, pressed individually or in combination). - Transliteration between regular text and Braille via a toolbar dropdown.
- A configuration dialog for setting words, Braille inputs,
transliteration direction, and strict mode per widget instance. - Speech synthesis integration for reading back content.
- API integration for fetching challenge data from an external endpoint.
Installation
Install in the usual Drupal way, preferably via Composer:
composer require drupal/ckeditor_brailleEnable the module, then navigate to
Administration → Configuration → Content authoring → Text formats, edit (or create) a format using CKEditor 5, and drag the Braille toolbar item into the active toolbar.
Drupal Configuration
Once the Braille toolbar item is added to a text format, a settings form appears on the Text format configuration page with the following sections: API, UI, Speech; See more about these in README.md.
The prebuilt assets
js/build/ckeditorbraille.umd.js and js/build/ckeditorbraille.css ship with the module and are ready to use without any build step.
Develop: TypeScript source
See the source on GitLab and see README.md for usage.
Supporting this Module
A big thanks to Northeast Resource Center for Vision Education for their support of the project.