@atlaskit/editor-plugin-quick-insert/report.api.md

Quick insert plugin for @atlaskit/editor-core

<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/editor-plugin-quick-insert"

> 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 { Command } from '@atlaskit/editor-common/types';
import type { EditorCommand } from '@atlaskit/editor-common/types';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { QuickInsertItem } from '@atlaskit/editor-common/provider-factory';
import type { QuickInsertPluginOptions } from '@atlaskit/editor-common/types';
import type { QuickInsertSearchOptions } from '@atlaskit/editor-common/types';
import type { QuickInsertSharedState as QuickInsertSharedState_2 } from '@atlaskit/editor-common/types';
import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
import type { TypeAheadInputMethod } from '@atlaskit/editor-plugin-type-ahead';
import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';

// @public (undocumented)
export type QuickInsertPlugin = NextEditorPlugin<
	'quickInsert',
	{
		pluginConfiguration: QuickInsertPluginOptions | undefined;
		dependencies: [TypeAheadPlugin];
		sharedState: QuickInsertSharedState | null;
		actions: {
			openTypeAhead: (inputMethod: TypeAheadInputMethod) => boolean;
			insertItem: (item: QuickInsertItem) => Command;
			getSuggestions: (searchOptions: QuickInsertSearchOptions) => QuickInsertItem[];
		};
		commands: {
			openElementBrowserModal: EditorCommand;
		};
	}
>;

// @public (undocumented)
export const quickInsertPlugin: QuickInsertPlugin;

// @public (undocumented)
export type QuickInsertSharedState = QuickInsertSharedState_2 & {
	typeAheadHandler: TypeAheadHandler;
};

// (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-->