@atlaskit/editor-plugin-quick-insert/README.md

Quick insert plugin for @atlaskit/editor-core

# Editor Plugin Quick Insert

Quick insert plugin for @atlaskit/editor-core

**Note:** This component is designed for internal Atlassian development.
External contributors will be able to use this component but will not be able to submit issues.

## Overview

The Quick Insert plugin provides a user-friendly interface for rapidly inserting content into the Atlassian Editor. It integrates with the editor's type-ahead system to enable contextual content insertion through the forward slash (`/`) trigger, along with an optional element browser modal for discovering and inserting available content elements.

## Key features

- **Type-ahead integration** - Trigger quick insert with the `/` key for instant content suggestions
- **Search and filter** - Find and filter available items with customizable search functionality
- **Element browser** - Optional modal interface for browsing and inserting content elements
- **Custom items** - Add, update, or remove custom quick insert items dynamically
- **Analytics support** - Track insertion actions and editor interactions
- **Configurable behavior** - Control empty states, item priority sorting, and element browser visibility

## Install
---
- **Install** - *yarn add @atlaskit/editor-plugin-quick-insert*
- **npm** - [@atlaskit/editor-plugin-quick-insert](https://www.npmjs.com/package/@atlaskit/editor-plugin-quick-insert)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-quick-insert)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-quick-insert/dist/)

## Usage
---
**Internal use only**

@atlaskit/editor-plugin-quick-insert is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.

Direct use of this component is not supported.

Please see [Atlaskit - Editor plugin quick insert](https://atlaskit.atlassian.com/packages/editor/editor-plugin-quick-insert) for documentation and examples for this package.

## Support
---
For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.

## License
---
Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.