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

Mentions plugin for @atlaskit/editor-core

# Editor Plugin Mentions

Mentions 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 Mentions plugin provides the ability to mention users and other entities within the Atlassian Editor. It integrates with @atlaskit/editor-core to enable mention functionality for editor users.

## Key features

- **User mentions** - Mention users within editor content
- **Entity resolution** - Resolve mentions to user profiles and data
- **Mention rendering** - Display mentions with appropriate styling and information

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

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

@atlaskit/editor-plugin-mentions 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 mentions](https://atlaskit.atlassian.com/packages/editor/editor-plugin-mentions) 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#Platform-License) for more licensing information.