@atlaskit/editor-plugin-highlight 7.3.14 → 7.3.16
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 +12 -0
- package/README.md +37 -3
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,9 +1,43 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Editor Plugin Highlight
|
|
2
2
|
|
|
3
3
|
Highlight plugin for @atlaskit/editor-core
|
|
4
4
|
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The Highlight plugin provides text highlighting capabilities for the Atlassian Editor. It allows users to highlight text with a customizable color palette, integrated with the editor's toolbar and keyboard shortcuts. The plugin manages highlight state, tracks analytics events, and supports both primary and selection toolbars.
|
|
8
|
+
|
|
9
|
+
## Key features
|
|
10
|
+
|
|
11
|
+
- **Color palette selection** - Choose from a predefined palette of highlight colors
|
|
12
|
+
- **Highlight removal** - Remove highlight from selected text
|
|
13
|
+
- **Toolbar integration** - Access highlighting through primary and selection toolbars
|
|
14
|
+
- **Keyboard shortcuts** - Quick keyboard access for toggling the palette and applying yellow highlight
|
|
15
|
+
- **State management** - Tracks active highlight color and palette visibility
|
|
16
|
+
- **Analytics tracking** - Records highlight actions for usage metrics
|
|
17
|
+
- **Visual enhancements** - Padding decorations for improved visual representation
|
|
18
|
+
|
|
19
|
+
## Install
|
|
20
|
+
---
|
|
21
|
+
- **Install** - *yarn add @atlaskit/editor-plugin-highlight*
|
|
22
|
+
- **npm** - [@atlaskit/editor-plugin-highlight](https://www.npmjs.com/package/@atlaskit/editor-plugin-highlight)
|
|
23
|
+
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-highlight)
|
|
24
|
+
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-highlight/dist/)
|
|
25
|
+
|
|
5
26
|
## Usage
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { highlightPlugin } from '@atlaskit/editor-plugin-highlight';
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The highlight plugin is intended for use as a plugin dependency within the Editor. It provides the `changeColor` command to programmatically change or remove highlight colors.
|
|
34
|
+
|
|
35
|
+
Please see [Atlaskit - Editor plugin highlight](https://atlaskit.atlassian.com/packages/editor/editor-plugin-highlight) for documentation and examples for this package.
|
|
6
36
|
|
|
7
|
-
|
|
37
|
+
## Support
|
|
38
|
+
---
|
|
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.
|
|
8
40
|
|
|
9
|
-
|
|
41
|
+
## License
|
|
42
|
+
---
|
|
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-highlight",
|
|
3
|
-
"version": "7.3.
|
|
3
|
+
"version": "7.3.16",
|
|
4
4
|
"description": "Highlight plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -49,13 +49,13 @@
|
|
|
49
49
|
"@atlaskit/icon": "^31.0.0",
|
|
50
50
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
51
51
|
"@atlaskit/primitives": "^18.0.0",
|
|
52
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
52
|
+
"@atlaskit/tmp-editor-statsig": "^27.1.0",
|
|
53
53
|
"@atlaskit/tokens": "^11.0.0",
|
|
54
54
|
"@babel/runtime": "^7.0.0",
|
|
55
55
|
"@emotion/react": "^11.7.1"
|
|
56
56
|
},
|
|
57
57
|
"peerDependencies": {
|
|
58
|
-
"@atlaskit/editor-common": "^111.
|
|
58
|
+
"@atlaskit/editor-common": "^111.16.0",
|
|
59
59
|
"react": "^18.2.0",
|
|
60
60
|
"react-intl-next": "npm:react-intl@^5.18.1"
|
|
61
61
|
},
|