# @atlaskit/editor-plugin-highlight

> Highlight plugin for @atlaskit/editor-core

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

## Install

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

## 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.2 |
| Published | 2026-11-18 |
| First published | 2024-04-26 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 23 |
| Unpacked size | 259.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

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

## Dependencies (23)

- [@atlaskit/css](https://npm.io/package/@atlaskit/css.md) ^1.1.0
- [@atlaskit/icon](https://npm.io/package/@atlaskit/icon.md) ^38.1.0
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.7.1
- [@atlaskit/tokens](https://npm.io/package/@atlaskit/tokens.md) ^20.14.0
- [@atlaskit/heading](https://npm.io/package/@atlaskit/heading.md) ^8.0.0
- [@atlaskit/adf-schema](https://npm.io/package/@atlaskit/adf-schema.md) ^57.7.0
- [@atlaskit/primitives](https://npm.io/package/@atlaskit/primitives.md) ^22.8.0
- [@atlaskit/editor-tables](https://npm.io/package/@atlaskit/editor-tables.md) ^3.2.0
- [@atlaskit/editor-palette](https://npm.io/package/@atlaskit/editor-palette.md) ^3.5.0
- [@atlaskit/editor-toolbar](https://npm.io/package/@atlaskit/editor-toolbar.md) ^2.11.0
- [@atlaskit/editor-prosemirror](https://npm.io/package/@atlaskit/editor-prosemirror.md) ^9.0.0
- [@atlaskit/tmp-editor-statsig](https://npm.io/package/@atlaskit/tmp-editor-statsig.md) ^266.0.0
- [@atlaskit/editor-shared-styles](https://npm.io/package/@atlaskit/editor-shared-styles.md) ^5.2.0
- [@atlaskit/editor-toolbar-model](https://npm.io/package/@atlaskit/editor-toolbar-model.md) ^1.2.0
- [@atlaskit/editor-plugin-toolbar](https://npm.io/package/@atlaskit/editor-plugin-toolbar.md) ^30.0.0
- [@atlaskit/platform-feature-flags](https://npm.io/package/@atlaskit/platform-feature-flags.md) ^2.2.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-primary-toolbar](https://npm.io/package/@atlaskit/editor-plugin-primary-toolbar.md) ^34.0.0
- [@atlaskit/editor-plugin-text-formatting](https://npm.io/package/@atlaskit/editor-plugin-text-formatting.md) ^34.0.0
- [@atlaskit/editor-plugin-user-preferences](https://npm.io/package/@atlaskit/editor-plugin-user-preferences.md) ^31.0.0
- [@atlaskit/editor-plugin-selection-toolbar](https://npm.io/package/@atlaskit/editor-plugin-selection-toolbar.md) ^34.0.0

## Recent versions

- 33.0.2 (latest) — 2026-11-18
- 33.0.1 — 2026-11-17
- 33.0.0 — 2026-11-17
- 32.0.0 — 2026-11-17
- 31.1.0 — 2026-11-17
- 31.0.0 — 2026-11-16
- 30.0.20 — 2026-11-16
- 30.0.19 — 2026-11-13
- 30.0.18 — 2026-11-12
- 30.0.17 — 2026-11-11
- 30.0.16 — 2026-11-09
- 30.0.15 — 2026-11-07
- 30.0.14 — 2026-11-06
- 30.0.13 — 2026-11-05
- 30.0.12 — 2026-11-05
- … 485 more at https://npm.io/package/@atlaskit/editor-plugin-highlight/versions

## README

# Editor Plugin Highlight

Highlight plugin for @atlaskit/editor-core

## Overview

The Highlight plugin provides text highlighting capabilities for the Atlassian Editor. It allows users to highlight text with a customizable color palette, integrated with the editor's toolbar and keyboard shortcuts. The plugin manages highlight state, tracks analytics events, and supports both primary and selection toolbars.

## Key features

- **Color palette selection** - Choose from a predefined palette of highlight colors
- **Highlight removal** - Remove highlight from selected text
- **Toolbar integration** - Access highlighting through primary and selection toolbars
- **Keyboard shortcuts** - Quick keyboard access for toggling the palette and applying yellow highlight
- **State management** - Tracks active highlight color and palette visibility
- **Analytics tracking** - Records highlight actions for usage metrics
- **Visual enhancements** - Padding decorations for improved visual representation

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

## Usage
---

```typescript
import { highlightPlugin } from '@atlaskit/editor-plugin-highlight';
```

The highlight plugin is intended for use as a plugin dependency within the Editor. It provides the `changeColor` command to programmatically change or remove highlight colors.

Please see [Atlaskit - Editor plugin highlight](https://atlaskit.atlassian.com/packages/editor/editor-plugin-highlight) 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-highlight · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
