# @atlaskit/editor-plugin-caption

> Caption plugin for @atlaskit/editor-core

Latest version **33.0.0** (published 2026-11-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @atlaskit/editor-plugin-caption
pnpm add @atlaskit/editor-plugin-caption
yarn add @atlaskit/editor-plugin-caption
bun add @atlaskit/editor-plugin-caption
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 33.0.0 |
| Published | 2026-11-17 |
| First published | 2023-10-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 92.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

- npm: https://www.npmjs.com/package/@atlaskit/editor-plugin-caption
- Repository: https://bitbucket.org/atlassian/atlassian-frontend-mirror
- Homepage: https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
- Issues: https://bitbucket.org/atlassian/atlassian-frontend-mirror/issues
- npm.io page: https://npm.io/package/@atlaskit/editor-plugin-caption

## Dependencies (7)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0
- [@atlaskit/adf-schema](https://npm.io/package/@atlaskit/adf-schema.md) ^57.7.0
- [@atlaskit/browser-apis](https://npm.io/package/@atlaskit/browser-apis.md) ^1.2.0
- [@atlaskit/editor-prosemirror](https://npm.io/package/@atlaskit/editor-prosemirror.md) ^9.0.0
- [@atlaskit/editor-plugin-analytics](https://npm.io/package/@atlaskit/editor-plugin-analytics.md) ^33.0.0
- [@atlaskit/platform-feature-experiments](https://npm.io/package/@atlaskit/platform-feature-experiments.md) ^0.3.0
- [@atlaskit/editor-plugin-editor-disabled](https://npm.io/package/@atlaskit/editor-plugin-editor-disabled.md) ^33.0.0

## Recent versions

- 33.0.0 (latest) — 2026-11-17
- 32.0.0 — 2026-11-17
- 31.0.0 — 2026-11-16
- 30.0.0 — 2026-10-27
- 29.0.0 — 2026-10-20
- 28.0.0 — 2026-10-16
- 27.0.0 — 2026-10-13
- 26.0.1 — 2026-10-08
- 26.0.0 — 2026-10-08
- 25.0.0 — 2026-10-07
- 24.0.0 — 2026-10-02
- 23.0.0 — 2026-10-01
- 22.0.0 — 2026-09-25
- 21.0.0 — 2026-09-24
- 20.0.0 — 2026-09-23
- … 146 more at https://npm.io/package/@atlaskit/editor-plugin-caption/versions

## README

# 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](https://www.npmjs.com/package/@atlaskit/editor-plugin-caption)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-caption)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-caption/dist/)

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

---
_Source: https://npm.io/package/@atlaskit/editor-plugin-caption · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
