@atlaskit/editor-plugin-layout
Version:
Layout plugin for @atlaskit/editor-core
43 lines (31 loc) • 2.33 kB
Markdown
# Editor Plugin Layout
Layout 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 Layout plugin provides layout section and column functionality for the Atlassian Editor. It enables users to create and manage multi-column layouts with support for various preset configurations including single column, two-column, three-column, four-column, and five-column layouts with optional sidebar arrangements.
## Key features
- **Multiple layout presets** - Support for various layout configurations (single, two-equal, three-equal, two-column with sidebars, three-column with sidebars, four-equal, five-equal)
- **Column management** - Create, insert, and manage layout sections with multiple columns
- **Resizing support** - Dynamically resize layout columns
- **Block menu integration** - Integrate layout options into the editor's block menu
- **Toolbar support** - Floating toolbar for quick layout editing
- **Analytics integration** - Track layout-related user actions and interactions
## Install
- **Install** - *yarn add @atlaskit/editor-plugin-layout*
- **npm** - [@atlaskit/editor-plugin-layout](https://www.npmjs.com/package/@atlaskit/editor-plugin-layout)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-layout)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-layout/dist/)
## Usage
**Internal use only**
@atlaskit/editor-plugin-layout 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 layout](https://atlaskit.atlassian.com/packages/editor/editor-plugin-layout) 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.