Editor Plugin Caption
Caption 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 Caption plugin provides support for adding captions to media elements in the Atlassian Editor. It enables users to attach descriptive text to media items, with built-in keyboard navigation, selection handling, and editor state management. The plugin integrates seamlessly with media single nodes and supports editor disabled states.
Key features
- Media captions - Add descriptive text captions to media elements
- Keyboard navigation - Full keyboard support for navigating in and out of captions (Enter, Arrow keys, Tab)
- Selection handling - Automatic caption deletion when empty, with edit tracking via analytics
- Editor state integration - Respects editor disabled states and prevents editing when appropriate
- Analytics tracking - Built-in analytics for caption creation, editing, and deletion events
Install
- Install - yarn add @atlaskit/editor-plugin-caption
- npm - @atlaskit/editor-plugin-caption
- Source - Bitbucket
- Bundle - unpkg.com
Usage
Internal use only
@atlaskit/editor-plugin-caption 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 Caption for documentation and examples for this package.
Support
For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.
License
Please see Atlassian Frontend - License for more licensing information.