Editor Plugin Grid

Grid 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 Grid plugin provides grid visualization and highlight capabilities for the Atlassian Editor. It enables displaying visual grid guides at various layout breakpoints (wide, full-width, or custom column widths) to help with content layout and alignment within the editor.

Key features

• Grid visualization - Display grid guides for layout reference and alignment
• Flexible grid types - Support for different grid types including wide and full-width layouts
• Breakout grid lines - Optional calculation of grid lines for breakout content
• Configurable highlights - Customize which grid columns and layout modes are highlighted
• Width plugin integration - Integrates with the width plugin for responsive layout support

Install

• Install - yarn add @atlaskit/editor-plugin-grid
• npm - @atlaskit/editor-plugin-grid
• Source - Bitbucket
• Bundle - unpkg.com

Usage

Internal use only

@atlaskit/editor-plugin-grid 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 grid 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.