UNPKG

@atlaskit/editor-plugin-accessibility-utils

Version:

Accessibility utils for @atlaskit/editor-core

bitbucket.org/atlassian/atlassian-frontend-monorepo

42 lines (29 loc) • 2.17 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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](https://www.npmjs.com/package/@atlaskit/editor-plugin-accessibility-utils) - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-accessibility-utils) - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-accessibility-utils/dist/) ## 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](https://atlaskit.atlassian.com/packages/editor/editor-plugin-accessibility-utils) for documentation and examples for this package. ## Support --- For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug. ## License --- Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.