Editor Plugin Accessibility Utils

Accessibility utils for @atlaskit/editor-core

Note: This component is designed for internal Atlassian development. External contributors will be able to use this component but will not be able to submit issues.

Overview

The Accessibility Utils plugin provides utilities and helpers for building accessible editor experiences. It enables screen reader announcements and manages ARIA live regions to communicate editor state changes and user actions to assistive technologies.

Key features

• Screen reader announcements - Announce messages to screen readers via ARIA live regions
• Configurable announcement priority - Support both standard status updates and urgent alerts
• Editor integration - Seamless integration with @atlaskit/editor-core
• Transaction-based updates - Leverage ProseMirror transactions for state management

Install

• Install - yarn add @atlaskit/editor-plugin-accessibility-utils
• npm - @atlaskit/editor-plugin-accessibility-utils
• Source - Bitbucket
• Bundle - unpkg.com

Usage

Internal use only

@atlaskit/editor-plugin-accessibility-utils is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.

Direct use of this component is not supported.

Please see Atlaskit - Editor plugin accessibility utils for documentation and examples for this package.

Support

For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.

License

Please see Atlassian Frontend - License for more licensing information.