@atlaskit/editor-plugin-panel
Version:
Panel plugin for @atlaskit/editor-core.
44 lines (32 loc) • 2.35 kB
Markdown
# Editor Plugin Panel
Panel 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 Panel plugin enables the creation and management of informational panel blocks within the Atlassian Editor. It provides various panel types for highlighting different kinds of content, with support for custom panels including configurable colors and emoji icons.
## Key features
- **Multiple panel types** - Support for info, note, warning, error, success, and tip panel types
- **Custom panels** - Create custom panels with configurable background colors and emoji icons
- **Floating toolbar** - Interactive toolbar for changing panel types and customizing appearance
- **Quick insert integration** - Quick insert menu support for all panel types
- **Block menu integration** - Transform structure menu integration for converting content to panels
- **Keyboard shortcuts** - Backspace handling for panel navigation and content management
- **Analytics integration** - Comprehensive event tracking for panel insertion and modifications
## Install
---
- **Install** - *yarn add @atlaskit/editor-plugin-panel*
- **npm** - [@atlaskit/editor-plugin-panel](https://www.npmjs.com/package/@atlaskit/editor-plugin-panel)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-panel)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-panel/dist/)
## Usage
---
**Internal use only**
@atlaskit/editor-plugin-panel 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 panel](https://atlaskit.atlassian.com/packages/editor/editor-plugin-panel) 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.