@atlaskit/editor-plugin-list/README.md

List plugin for @atlaskit/editor-core

# Editor Plugin List

List 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 List plugin provides comprehensive list management capabilities for the Atlassian Editor. It enables users to create, format, and manipulate both bullet and ordered lists with support for nested lists, indentation, and keyboard shortcuts for efficient list operations.

## Key features

- **Bullet and ordered lists** - Create and toggle between unordered and ordered lists
- **List indentation** - Indent and outdent list items with automatic nesting
- **Keyboard shortcuts** - Quick insert support for list creation with keyboard navigation
- **Analytics integration** - Track list-related actions and user interactions
- **Block menu support** - Integrate with the editor's block menu for list insertion
- **Flexible list items** - Support for various list item configurations with local IDs

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

## Usage

**Internal use only**

@atlaskit/editor-plugin-list 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 list](https://atlaskit.atlassian.com/packages/editor/editor-plugin-list) 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.