UNPKG

@atlaskit/editor-plugin-panel

Version:

Panel plugin for @atlaskit/editor-core.

71 lines (53 loc) 1.95 kB
<!-- API Report Version: 2.3 --> ## API Report File for "@atlaskit/editor-plugin-panel" > 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 { INPUT_METHOD } 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'; // @public (undocumented) export type PanelPlugin = NextEditorPlugin< 'panel', { pluginConfiguration: PanelPluginOptions | undefined; dependencies: [typeof decorationsPlugin, OptionalPlugin<typeof analyticsPlugin>]; actions: { insertPanel: (inputMethod: INPUT_METHOD) => Command; }; } >; // @public (undocumented) export const panelPlugin: PanelPlugin; // @public (undocumented) export interface PanelPluginConfig { // (undocumented) allowCustomPanel?: boolean; // (undocumented) allowCustomPanelEdit?: boolean; } // @public (undocumented) interface PanelPluginOptions extends LongPressSelectionPluginOptions, PanelPluginConfig {} // (No @packageDocumentation comment for this package) ``` <!--SECTION END: Main Entry Types--> ### Peer Dependencies <!--SECTION START: Peer Dependencies--> ```json { "react": "^16.8.0", "react-dom": "^16.8.0", "react-intl": "npm:react-intl@^5.18.1" } ``` <!--SECTION END: Peer Dependencies-->