Accessibility in the JavaScript Markdown Editor Control
18 Nov 20184 minutes to read
The Markdown Editor is designed to be fully accessible, following WAI-ARIA specifications and implementing ARIA roles, states, and properties. These accessibility features ensure that the editor is user-friendly for individuals relying on assistive technologies (AT) or keyboard navigation.
The following table summarizes the accessibility support of the Markdown Editor control:
- All features of the control meet the requirement.
- Some features of the control do not meet the requirement.
- The control does not meet the requirement.ARIA Attributes
The toolbar in the Rich Text Editor is assigned the role of ‘Toolbar’ and includes the following attributes.
| Property | Functionalities |
|---|---|
| role=”toolbar” | This attribute added to the ToolBar element describes the actual role of the element. |
| aria-orientation | Indicates the ToolBar orientation. Default value is horizontal. |
| aria-haspopup | Indicates the popup mode of the Toolbar. Default value is false. When popup mode is enabled, attribute value has to be changed to true. |
| aria-disabled | Indicates the disabled state of the toolbar. |
| aria-owns | Identifies an element to define a visual, functional, or contextual parent/child relationship between DOM elements when the DOM hierarchy cannot represent the relationship. In the Markdown Editor, the attribute contains the ID of the Markdown Editor to indicate the popup as a child element. |
For more details on Toolbar ARIA attributes, refer to the Accessibility of Toolbar documentation.
- The Markdown Editor element is assigned the role of
application.
| Property | Functionalities |
|---|---|
| role=”application” | This attribute added to the Markdown Editor element describes the actual role of the element. |
| aria-disabled | Indicates the disabled state of the ToolBar. |
Keyboard Navigation
The Markdown Editor control followed the keyboard interaction guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Markdown Editor control.
For more details on keyboard navigation, refer to the Keyboard support documentation.
Customizing Shortcut Keys
You can customize shortcut keys using the formatter property.This allows you to configure custom key combinations for various actions in the Markdown Editor. For example, you can set ctrl+q to open the Insert Hyperlink dialog.
We need to import
IMarkdownFormatterModelandMarkdownFormatterto configure the shortcut key.
Implementing Accessibility Best Practices
The Markdown Editor control’s accessibility levels are ensured through an accessibility-checker and axe-core software tools during automated testing.