UNPKG

@atlaskit/editor-plugin-grid

Version:

Grid plugin for @atlaskit/editor-core

bitbucket.org/atlassian/atlassian-frontend-mirror

42 lines (30 loc) • 2.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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](https://www.npmjs.com/package/@atlaskit/editor-plugin-grid) - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-grid) - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-grid/dist/) ## 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](https://atlaskit.atlassian.com/packages/editor/editor-plugin-grid) 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.