@atlaskit/editor-plugin-emoji
Version:
Emoji plugin for @atlaskit/editor-core
42 lines (30 loc) • 2.08 kB
Markdown
# Editor Plugin Emoji
Emoji 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 Emoji plugin provides emoji insertion and selection capabilities for the Atlassian Editor. It integrates with `@atlaskit/emoji` to offer type-ahead emoji search, ASCII shortcode conversion, and inline emoji popup support.
## Key features
- **Type-ahead emoji search** - Search and insert emojis using the `:` trigger with type-ahead filtering
- **ASCII emoji shortcodes** - Automatic conversion of ASCII emoji codes to emoji characters
- **Inline emoji popup** - Quick emoji selection via popup interface
- **Emoji analytics** - Track emoji selection events and usage metrics
- **Provider integration** - Flexible emoji provider configuration for custom emoji sources
## Install
- **Install** - *yarn add @atlaskit/editor-plugin-emoji*
- **npm** - [@atlaskit/editor-plugin-emoji](https://www.npmjs.com/package/@atlaskit/editor-plugin-emoji)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-emoji)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-emoji/dist/)
## Usage
**Internal use only**
@atlaskit/editor-plugin-emoji 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 emoji](https://atlaskit.atlassian.com/packages/editor/editor-plugin-emoji) 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.