@atlaskit/editor-plugin-insert-block
Version:
Insert block plugin for @atlaskit/editor-core
116 lines (98 loc) • 3.92 kB
Markdown
<!-- API Report Version: 2.3 -->
## API Report File for "@atlaskit/editor-plugin-insert-block"
> 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 '/editor-plugin-analytics';
import type { BlockTypePlugin } from '/editor-plugin-block-type';
import type { CodeBlockPlugin } from '/editor-plugin-code-block';
import type { DatePlugin } from '/editor-plugin-date';
import type { EmojiPlugin } from '/editor-plugin-emoji';
import type { ExpandPlugin } from '/editor-plugin-expand';
import type { ExtensionPlugin } from '/editor-plugin-extension';
import type { FeatureFlagsPlugin } from '/editor-plugin-feature-flags';
import type { HyperlinkPlugin } from '/editor-plugin-hyperlink';
import type { ImageUploadPlugin } from '/editor-plugin-image-upload';
import type { LayoutPlugin } from '/editor-plugin-layout';
import type { MediaPlugin } from '/editor-plugin-media';
import type { MentionsPlugin } from '/editor-plugin-mentions';
import type { NextEditorPlugin } from '/editor-common/types';
import type { OptionalPlugin } from '/editor-common/types';
import type { PanelPlugin } from '/editor-plugin-panel';
import type { PlaceholderTextPlugin } from '/editor-plugin-placeholder-text';
import type { QuickInsertPlugin } from '/editor-plugin-quick-insert';
import type { RulePlugin } from '/editor-plugin-rule';
import type { StatusPlugin } from '/editor-plugin-status';
import type { TablePlugin } from '/editor-plugin-table';
import type { TasksAndDecisionsPlugin } from '/editor-plugin-tasks-and-decisions';
import type { TypeAheadPlugin } from '/editor-plugin-type-ahead';
// @public (undocumented)
interface InsertBlockOptions {
// (undocumented)
allowExpand?: boolean;
// (undocumented)
allowTables?: boolean;
// (undocumented)
horizontalRuleEnabled?: boolean;
// (undocumented)
insertMenuItems?: any;
// (undocumented)
nativeStatusSupported?: boolean;
// (undocumented)
replacePlusMenuWithElementBrowser?: boolean;
// (undocumented)
showElementBrowserLink?: boolean;
}
// @public (undocumented)
export type InsertBlockPlugin = NextEditorPlugin<
'insertBlock',
{
pluginConfiguration: InsertBlockOptions | undefined;
dependencies: InsertBlockPluginDependencies;
}
>;
// @public (undocumented)
export const insertBlockPlugin: InsertBlockPlugin;
// @public (undocumented)
type InsertBlockPluginDependencies = [
OptionalPlugin<FeatureFlagsPlugin>,
TypeAheadPlugin,
OptionalPlugin<TablePlugin>,
OptionalPlugin<HyperlinkPlugin>,
OptionalPlugin<DatePlugin>,
OptionalPlugin<BlockTypePlugin>,
OptionalPlugin<AnalyticsPlugin>,
OptionalPlugin<ImageUploadPlugin>,
OptionalPlugin<EmojiPlugin>,
OptionalPlugin<QuickInsertPlugin>,
OptionalPlugin<RulePlugin>,
OptionalPlugin<CodeBlockPlugin>,
OptionalPlugin<PanelPlugin>,
OptionalPlugin<MediaPlugin>,
OptionalPlugin<MentionsPlugin>,
OptionalPlugin<StatusPlugin>,
OptionalPlugin<LayoutPlugin>,
OptionalPlugin<ExpandPlugin>,
OptionalPlugin<PlaceholderTextPlugin>,
OptionalPlugin<ExtensionPlugin>,
OptionalPlugin<TasksAndDecisionsPlugin>,
];
// (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-->