@atlaskit/editor-plugin-caption 8.0.2 → 8.0.3
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 +8 -0
- package/README.md +13 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @atlaskit/editor-plugin-caption
|
|
2
2
|
|
|
3
|
+
## 8.0.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`82c0224977f47`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/82c0224977f47) -
|
|
8
|
+
Update README.md and 0-intro.tsx
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
|
|
3
11
|
## 8.0.2
|
|
4
12
|
|
|
5
13
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -5,6 +5,18 @@ Caption plugin for @atlaskit/editor-core
|
|
|
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 Caption plugin provides support for adding captions to media elements in the Atlassian Editor. It enables users to attach descriptive text to media items, with built-in keyboard navigation, selection handling, and editor state management. The plugin integrates seamlessly with media single nodes and supports editor disabled states.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Media captions** - Add descriptive text captions to media elements
|
|
15
|
+
- **Keyboard navigation** - Full keyboard support for navigating in and out of captions (Enter, Arrow keys, Tab)
|
|
16
|
+
- **Selection handling** - Automatic caption deletion when empty, with edit tracking via analytics
|
|
17
|
+
- **Editor state integration** - Respects editor disabled states and prevents editing when appropriate
|
|
18
|
+
- **Analytics tracking** - Built-in analytics for caption creation, editing, and deletion events
|
|
19
|
+
|
|
8
20
|
## Install
|
|
9
21
|
---
|
|
10
22
|
- **Install** - *yarn add @atlaskit/editor-plugin-caption*
|
|
@@ -25,6 +37,7 @@ Please see [Atlaskit - Editor plugin Caption](https://atlaskit.atlassian.com/pac
|
|
|
25
37
|
## Support
|
|
26
38
|
---
|
|
27
39
|
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.
|
|
40
|
+
|
|
28
41
|
## License
|
|
29
42
|
---
|
|
30
43
|
Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-caption",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.3",
|
|
4
4
|
"description": "Caption plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"@babel/runtime": "^7.0.0"
|
|
35
35
|
},
|
|
36
36
|
"peerDependencies": {
|
|
37
|
-
"@atlaskit/editor-common": "^112.
|
|
37
|
+
"@atlaskit/editor-common": "^112.18.0",
|
|
38
38
|
"react": "^18.2.0"
|
|
39
39
|
},
|
|
40
40
|
"techstack": {
|