## API Report File for "@atlaskit/editor-plugin-grid" > Do not edit this file. This report is auto-generated using > [API Extractor](https://api-extractor.com/). > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports) ### Table of contents - [Main Entry Types](#main-entry-types) - [Peer Dependencies](#peer-dependencies) ### Main Entry Types ```ts import type { EditorView } from '@atlaskit/editor-prosemirror/view'; import type { GridType } from '@atlaskit/editor-common/types'; import type { NextEditorPlugin } from '@atlaskit/editor-common/types'; import type { WidthPlugin } from '@atlaskit/editor-plugin-width'; // @public (undocumented) type CreateDisplayGrid = (view: EditorView) => DisplayGrid; // @public (undocumented) type DisplayGrid = (props: Required_2) => boolean; // @public (undocumented) export type GridPlugin = NextEditorPlugin< 'grid', { pluginConfiguration: GridPluginOptions | undefined; dependencies: [WidthPlugin]; sharedState: GridPluginState | null; actions: { displayGrid: CreateDisplayGrid; }; } >; // @public export const gridPlugin: GridPlugin; // @public (undocumented) export interface GridPluginOptions { // (undocumented) shouldCalcBreakoutGridLines?: boolean; } // @public (undocumented) export type GridPluginState = { visible: boolean; gridType?: GridType; highlight: Highlights; }; // @public (undocumented) export type Highlights = Array<'full-width' | 'wide' | number>; // @public (undocumented) type Required_2 = { [P in keyof T]-?: T[P]; }; // (No @packageDocumentation comment for this package) ``` ### Peer Dependencies ```json { "react": "^16.8.0" } ```