@atlaskit/editor-plugin-help-dialog 8.0.29 → 8.0.31
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 +14 -0
- package/README.md +14 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @atlaskit/editor-plugin-help-dialog
|
|
2
2
|
|
|
3
|
+
## 8.0.31
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`3da5fc5ff18bc`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3da5fc5ff18bc) -
|
|
8
|
+
Update README.md and 0-intro.tsx
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
|
|
11
|
+
## 8.0.30
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies
|
|
16
|
+
|
|
3
17
|
## 8.0.29
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,10 +1,23 @@
|
|
|
1
|
-
# Editor
|
|
1
|
+
# Editor Plugin Help Dialog
|
|
2
2
|
|
|
3
3
|
Help Dialog 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 Help Dialog plugin provides an interactive modal interface that displays helpful information about editor features, keyboard shortcuts, and formatting options. It integrates with the editor's quick insert functionality and supports dynamic configuration based on available features like image uploads and AI capabilities.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Help dialog modal** - Display a comprehensive help interface with formatting shortcuts and editor tips
|
|
15
|
+
- **Keyboard shortcuts** - Open/close help dialog using keyboard shortcuts (?)
|
|
16
|
+
- **Feature detection** - Dynamically adapt help content based on enabled features (image uploads, AI)
|
|
17
|
+
- **Quick insert integration** - Access help dialog through the quick insert menu
|
|
18
|
+
- **State management** - Track and manage the visibility state of the help dialog
|
|
19
|
+
- **Keyboard navigation** - Close dialog with Escape key for better accessibility
|
|
20
|
+
|
|
8
21
|
## Install
|
|
9
22
|
---
|
|
10
23
|
- **Install** - *yarn add @atlaskit/editor-plugin-help-dialog*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-help-dialog",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.31",
|
|
4
4
|
"description": "Help Dialog plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -37,9 +37,9 @@
|
|
|
37
37
|
"@atlaskit/icon": "^34.0.0",
|
|
38
38
|
"@atlaskit/modal-dialog": "^14.15.0",
|
|
39
39
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
40
|
-
"@atlaskit/primitives": "^
|
|
41
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
42
|
-
"@atlaskit/tokens": "^
|
|
40
|
+
"@atlaskit/primitives": "^19.0.0",
|
|
41
|
+
"@atlaskit/tmp-editor-statsig": "^60.2.0",
|
|
42
|
+
"@atlaskit/tokens": "^13.0.0",
|
|
43
43
|
"@atlaskit/tooltip": "^21.1.0",
|
|
44
44
|
"@babel/runtime": "^7.0.0",
|
|
45
45
|
"@emotion/react": "^11.7.1",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"@testing-library/react": "^16.3.0"
|
|
51
51
|
},
|
|
52
52
|
"peerDependencies": {
|
|
53
|
-
"@atlaskit/editor-common": "^112.
|
|
53
|
+
"@atlaskit/editor-common": "^112.20.0",
|
|
54
54
|
"react": "^18.2.0"
|
|
55
55
|
},
|
|
56
56
|
"techstack": {
|