UNPKG

@atlaskit/editor-plugin-annotation

Version:

Annotation plugin for @atlaskit/editor-core

bitbucket.org/atlassian/atlassian-frontend-mirror

42 lines (30 loc) • 2.19 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 Annotation Annotation plugin 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 Annotation plugin provides comprehensive inline commenting and annotation capabilities for the Atlassian Editor. It enables users to add, resolve, and manage annotations directly within the editor, with support for various annotation types including inline comments on text and block-level content. ## Key features - **Inline comments** - Add comments to text selections and block-level content - **Annotation marks** - Mark and track annotations within the editor document - **Comment state management** - Manage draft and resolved comment states - **Multiple annotation types** - Support for different annotation providers and types - **Toolbar integration** - Seamless integration with the editor toolbar for comment actions ## Install --- - **Install** - *yarn add @atlaskit/editor-plugin-annotation* - **npm** - [@atlaskit/editor-plugin-annotation](https://www.npmjs.com/package/@atlaskit/editor-plugin-annotation) - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-annotation) - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-annotation/dist/) ## Usage --- **Internal use only** @atlaskit/editor-plugin-annotation 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 annotation](https://atlaskit.atlassian.com/packages/editor/editor-plugin-annotation) 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.