UNPKG

@atlaskit/editor-plugin-expand

Version:

Expand plugin for @atlaskit/editor-core

93 lines (73 loc) 2.6 kB
<!-- API Report Version: 2.3 --> ## API Report File for "@atlaskit/editor-plugin-expand" > 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 { EditorAppearance } from '@atlaskit/editor-common/types'; import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags'; 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 { SelectionPlugin } from '@atlaskit/editor-plugin-selection'; // @public (undocumented) export type ExpandPlugin = NextEditorPlugin< 'expand', { pluginConfiguration: ExpandPluginOptions_2 | undefined; dependencies: [ OptionalPlugin<FeatureFlagsPlugin>, DecorationsPlugin, SelectionPlugin, OptionalPlugin<AnalyticsPlugin>, ]; actions: { insertExpand: ReturnType<typeof insertExpand>; }; } >; // @public (undocumented) export const expandPlugin: ExpandPlugin; // @public (undocumented) export interface ExpandPluginOptions extends LongPressSelectionPluginOptions { // (undocumented) allowInsertion?: boolean; // (undocumented) appearance?: EditorAppearance; } // @public (undocumented) interface ExpandPluginOptions_2 extends LongPressSelectionPluginOptions { // (undocumented) allowInsertion?: boolean; // (undocumented) appearance?: EditorAppearance; } // @public (undocumented) export interface ExpandPluginState { // (undocumented) expandRef?: HTMLDivElement | null; } // @public (undocumented) const insertExpand: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => Command; // (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-next": "npm:react-intl@^5.18.1" } ``` <!--SECTION END: Peer Dependencies-->