@atlaskit/editor-plugin-save-on-enter 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 -2
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,10 +1,21 @@
|
|
|
1
|
-
# Editor
|
|
1
|
+
# Editor Plugin Save-on-enter
|
|
2
2
|
|
|
3
3
|
Save-on-enter 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 Save-on-enter plugin enables automatic saving of editor content when the Enter key is pressed under specific conditions. It integrates with the Atlassian Editor to provide a streamlined save experience with analytics tracking.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Keyboard shortcut handling** - Triggers save action when Enter key is pressed in appropriate contexts
|
|
15
|
+
- **Smart context detection** - Only activates in valid save contexts (top-level paragraphs, non-empty tasks/decisions)
|
|
16
|
+
- **Analytics integration** - Tracks save events with detailed analytics payloads
|
|
17
|
+
- **Configurable callback** - Accepts a custom save handler to integrate with your save workflow
|
|
18
|
+
|
|
8
19
|
## Install
|
|
9
20
|
---
|
|
10
21
|
- **Install** - *yarn add @atlaskit/editor-plugin-save-on-enter*
|
|
@@ -27,4 +38,4 @@ Please see [Atlaskit - Editor plugin Save-on-enter](https://atlaskit.atlassian.c
|
|
|
27
38
|
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.
|
|
28
39
|
## License
|
|
29
40
|
---
|
|
30
|
-
Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#
|
|
41
|
+
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-save-on-enter",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.2",
|
|
4
4
|
"description": "Save-on-enter plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -28,12 +28,12 @@
|
|
|
28
28
|
"atlaskit:src": "src/index.ts",
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"@atlaskit/editor-prosemirror": "^7.3.0",
|
|
31
|
-
"@atlaskit/link": "^3.
|
|
31
|
+
"@atlaskit/link": "^3.4.0",
|
|
32
32
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
33
33
|
"@babel/runtime": "^7.0.0"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@atlaskit/editor-common": "^112.
|
|
36
|
+
"@atlaskit/editor-common": "^112.19.0",
|
|
37
37
|
"react": "^18.2.0"
|
|
38
38
|
},
|
|
39
39
|
"techstack": {
|