| layout | post |
|---|---|
| title | Accessibility in Blazor Markdown Editor Component | Syncfusion® |
| description | Checkout and learn here all about the accessibility in Blazor Markdown Editor component and much more details. |
| platform | Blazor |
| control | MarkdownEditor |
| documentation | ug |
The Blazor Markdown Editor component has been designed, keeping in mind the WAI-ARIA specifications, and applies the WAI-ARIA roles, states, and properties. This component is characterized by complete ARIA accessibility support that makes it easy for people who use assistive technologies (AT) or those who completely rely on keyboard navigation.
The Blazor Markdown Editor component followed the accessibility guidelines and standards, including ADA, Section 508, WCAG 2.2 standards, and WCAG roles that are commonly used to evaluate accessibility.
The accessibility compliance for the Blazor Markdown Editor component is outlined below.
| Accessibility Criteria | Compatibility |
|---|---|
| WCAG 2.2 Support | AA |
| Section 508 Support |  |
| Screen Reader Support | |
| Right-To-Left Support | |
| Color Contrast |  |
| Mobile Device Support | |
| Keyboard Navigation | |
| Axe-core Accessibility Validation | |
- All features of the component meet the requirement. - Some features of the component do not meet the requirement.
- The component does not meet the requirement.The toolbar in the Blazor Markdown Editor is assigned the role of toolbar and includes the following WAI-ARIA attribute.
| Property | Functionalities |
|---|---|
role="toolbar" |
Describes the actual role of the toolbar element. |
aria-orientation |
Indicates the toolbar orientation. Default is horizontal. |
aria-haspopup |
Indicates whether the toolbar has a popup. Default is false. Set to true when popup mode is enabled. |
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 information about toolbar ARIA attributes, refer to the accessibility of Toolbar documentation.
The Blazor Markdown Editor element is assigned the role of application:
| Property | Functionalities |
|---|---|
role="application" |
Describes the actual role of the Markdown Editor element. |
aria-disabled |
Indicates the disabled state of the toolbar. |
{% tabs %} {% highlight razor %}
{% include_relative code-snippet/markdown-aria-attribute.razor %}
{% endhighlight %} {% endtabs %}
The Blazor Markdown Editor component follows the keyboard interaction guidelines, 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 component.
For more details on keyboard navigation, refer to the Keyboard support documentation.
Accessibility levels are validated using the axe-core software tool during automated testing.
The accessibility compliance of the Markdown Editor component is shown in the following sample. Open the sample in a new window to evaluate the accessibility of the Markdown Editor component with accessibility tools.
Customize the key configuration for the keyboard interaction of the Markdown Editor using the KeyConfigure property.
In the following code block, customize the bold and italic, toolbar actions with ctrl+1, ctrl+2 respectively.
{% tabs %} {% highlight razor %}
{% include_relative code-snippet/markdown-custom-key-config.razor%}
{% endhighlight %} {% endtabs %}
N> You can refer to our Blazor Rich Text Editor feature tour page for its groundbreaking feature representations. You can also explore our Blazor Markdown Editor example to knows how to render and configure the Markdown Editor tools.