@atlaskit/editor-plugin-layout
Version:
Layout plugin for @atlaskit/editor-core
75 lines (57 loc) • 2.18 kB
Markdown
<!-- API Report Version: 2.3 -->
## API Report File for "@atlaskit/editor-plugin-layout"
> 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
<!--SECTION START: Main Entry Types-->
```ts
import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
import type { Command } from '@atlaskit/editor-common/types';
import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
import type { LongPressSelectionPluginOptions } from '@atlaskit/editor-common/types';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { OptionalPlugin } from '@atlaskit/editor-common/types';
import type { TOOLBAR_MENU_TYPE } from '@atlaskit/editor-common/types';
// @public (undocumented)
const insertLayoutColumnsWithAnalytics: (
editorAnalyticsAPI: EditorAnalyticsAPI | undefined,
) => (inputMethod: TOOLBAR_MENU_TYPE) => Command;
// @public (undocumented)
export type LayoutPlugin = NextEditorPlugin<
'layout',
{
pluginConfiguration: LayoutPluginOptions | undefined;
dependencies: [DecorationsPlugin, OptionalPlugin<AnalyticsPlugin>];
actions: {
insertLayoutColumns: ReturnType<typeof insertLayoutColumnsWithAnalytics>;
};
}
>;
// @public (undocumented)
export const layoutPlugin: LayoutPlugin;
// @public (undocumented)
export interface LayoutPluginOptions extends LongPressSelectionPluginOptions {
// (undocumented)
allowBreakout?: boolean;
// (undocumented)
UNSAFE_addSidebarLayouts?: boolean;
// (undocumented)
UNSAFE_allowSingleColumnLayout?: boolean;
}
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
### Peer Dependencies
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0",
"react-intl": "npm:react-intl@^5.18.1"
}
```
<!--SECTION END: Peer Dependencies-->