@atlaskit/editor-plugin-expand
Version:
Expand plugin for @atlaskit/editor-core
46 lines (33 loc) • 2.49 kB
Markdown
# Editor Plugin Expand
Expand 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 Expand plugin provides collapsible/expandable content sections for the Atlassian Editor. It supports both standard expand nodes and nested expand nodes, enabling users to organize and structure content with accordion-like functionality.
## Key features
- **Expand and nested expand nodes** - Support for both top-level expand and nested expand content structures
- **Interactive expand/collapse** - Toggle expand nodes open or closed with configurable interactive behavior
- **Quick insert integration** - Insert expand nodes via quick insert menu with keywords like 'accordion' and 'collapse'
- **Range toggle commands** - Programmatically expand or collapse multiple expand nodes across a document range
- **Floating toolbar** - Context-aware toolbar for expand node manipulation
- **Keyboard shortcuts** - Keymap support for efficient expand node navigation and manipulation
- **Configurable insertion** - Control expand node insertion permissions via plugin options
- **Live Page support** - Special handling for Confluence Live Page editor with divergent behavior
## Install
---
- **Install** - *yarn add @atlaskit/editor-plugin-expand*
- **npm** - [@atlaskit/editor-plugin-expand](https://www.npmjs.com/package/@atlaskit/editor-plugin-expand)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-expand)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-expand/dist/)
## Usage
---
**Internal use only**
@atlaskit/editor-plugin-expand 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 expand](https://atlaskit.atlassian.com/packages/editor/editor-plugin-expand) 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.