Editor Plugin Highlight
Highlight plugin for @atlaskit/editor-core
Overview
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.
Key features
- Color palette selection - Choose from a predefined palette of highlight colors
- Highlight removal - Remove highlight from selected text
- Toolbar integration - Access highlighting through primary and selection toolbars
- Keyboard shortcuts - Quick keyboard access for toggling the palette and applying yellow highlight
- State management - Tracks active highlight color and palette visibility
- Analytics tracking - Records highlight actions for usage metrics
- Visual enhancements - Padding decorations for improved visual representation
Install
- Install - yarn add @atlaskit/editor-plugin-highlight
- npm - @atlaskit/editor-plugin-highlight
- Source - Bitbucket
- Bundle - unpkg.com
Usage
import { highlightPlugin } from '@atlaskit/editor-plugin-highlight';
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.
Please see Atlaskit - Editor plugin highlight for documentation and examples for this package.
Support
For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.
License
Please see Atlassian Frontend - License for more licensing information.