@atlaskit/editor-plugin-text-color
Version:
Text color plugin for @atlaskit/editor-core
43 lines (31 loc) • 2.3 kB
Markdown
# Editor Plugin Text Color
Text color plugin for @atlaskit/editor-core
**Note:** This component is designed for internal Atlassian development.
External contributors will be able to use this component but will not be able to submit issues.
## Overview
The Text Color plugin enables users to apply custom text colors to their content in the Atlassian Editor. It provides a color palette interface and integrates with the editor's toolbar and selection toolbar to offer intuitive color selection and application.
## Key features
- **Color palette** - Access a customizable palette of text colors with default and custom color options
- **Toolbar integration** - Seamless integration with primary toolbar and floating selection toolbar
- **Color state management** - Track and manage active text color state across the document
- **Configurable defaults** - Configure default text color and toolbar component visibility
- **Commands and actions** - Programmatic API to change colors and control palette visibility
- **Keyboard support** - Keyboard shortcuts for color operations via keymap plugin
## Install
- **Install** - *yarn add @atlaskit/editor-plugin-text-color*
- **npm** - [@atlaskit/editor-plugin-text-color](https://www.npmjs.com/package/@atlaskit/editor-plugin-text-color)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-text-color)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-text-color/dist/)
## Usage
**Internal use only**
@atlaskit/editor-plugin-text-color is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
Direct use of this component is not supported.
Please see [Atlaskit - Editor plugin text color](https://atlaskit.atlassian.com/packages/editor/editor-plugin-text-color) for documentation and examples for this package.
## Support
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.
## License
Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.