@atlaskit/editor-plugin-annotation 8.0.1 → 8.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +13 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,10 +1,22 @@
|
|
|
1
|
-
# Editor
|
|
1
|
+
# Editor Plugin Annotation
|
|
2
2
|
|
|
3
3
|
Annotation plugin for @atlaskit/editor-core
|
|
4
4
|
|
|
5
5
|
**Note:** This component is designed for internal Atlassian development.
|
|
6
6
|
External contributors will be able to use this component but will not be able to submit issues.
|
|
7
7
|
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
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.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Inline comments** - Add comments to text selections and block-level content
|
|
15
|
+
- **Annotation marks** - Mark and track annotations within the editor document
|
|
16
|
+
- **Comment state management** - Manage draft and resolved comment states
|
|
17
|
+
- **Multiple annotation types** - Support for different annotation providers and types
|
|
18
|
+
- **Toolbar integration** - Seamless integration with the editor toolbar for comment actions
|
|
19
|
+
|
|
8
20
|
## Install
|
|
9
21
|
---
|
|
10
22
|
- **Install** - *yarn add @atlaskit/editor-plugin-annotation*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-annotation",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.2",
|
|
4
4
|
"description": "Annotation plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"react-intl-next": "npm:react-intl@^5.18.1"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"@atlaskit/editor-common": "^112.
|
|
47
|
+
"@atlaskit/editor-common": "^112.1.0",
|
|
48
48
|
"react": "^18.2.0",
|
|
49
49
|
"react-dom": "^18.2.0"
|
|
50
50
|
},
|