# @atlaskit/editor-plugin-content-format

> ContentFormat plugin for @atlaskit/editor-core

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

## Install

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

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 27.0.0 |
| Published | 2026-11-17 |
| First published | 2026-01-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 26.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

- npm: https://www.npmjs.com/package/@atlaskit/editor-plugin-content-format
- 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-content-format

## Dependencies (2)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0
- [@atlaskit/editor-prosemirror](https://npm.io/package/@atlaskit/editor-prosemirror.md) ^9.0.0

## Recent versions

- 27.0.0 (latest) — 2026-11-17
- 26.0.0 — 2026-11-17
- 25.0.0 — 2026-11-16
- 24.0.0 — 2026-10-27
- 23.0.0 — 2026-10-20
- 22.0.0 — 2026-10-16
- 21.0.0 — 2026-10-13
- 20.0.0 — 2026-10-08
- 19.0.0 — 2026-10-07
- 18.0.0 — 2026-10-02
- 17.0.0 — 2026-10-01
- 16.0.0 — 2026-09-25
- 15.0.0 — 2026-09-24
- 14.0.0 — 2026-09-23
- 13.0.0 — 2026-09-17
- … 17 more at https://npm.io/package/@atlaskit/editor-plugin-content-format/versions

## README

# Editor Plugin Content Format

ContentFormat 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 Content Format plugin provides centralized state management for tracking the editor's content mode/format. It enables plugins and products to monitor and update the current editor content format state.

## Key features

- **Content mode tracking** - Maintains the current content mode of the editor (e.g., `standard`, `compact`, etc.)
- **Shared state management** - Provides a centralized state accessible to all dependent plugins
- **Command API** - Simple command interface for updating content mode
- **Optimized updates** - Prevents unnecessary state updates when mode hasn't changed

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

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


### Accessing Content Mode State

You will need to add the plugin as an optional dependancy wherever you are going to need to access the state:

```typescript
import type {
	OptionalPlugin,
} from '@atlaskit/editor-common/types';
// ...
import type { ContentFormatPlugin } from '@atlaskit/editor-plugin-content-format';
// ...



export type YourPluginDependencies = [
	// ...
	OptionalPlugin<ContentFormatPlugin>,
	// ...
];
```

#### Accessing Content Mode State in your plugin

In your plugins access state like so:

```typescript
const contentMode = api?.contentFormat?.sharedState?.currentState()?.contentMode
```

#### Accessing Content Mode State in React Components

In React components that need to react to content mode changes, use the `useSharedPluginStateWithSelector` hook:

```typescript
import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
import type { PublicPluginAPI } from '@atlaskit/editor-common/types';
import type { ContentFormatPlugin } from '@atlaskit/editor-plugin-content-format';

type Props = {
  editorApi?: PublicPluginAPI<[ContentFormatPlugin]>;
};

export const MyComponent = ({ editorApi }: Props) => {
  const { contentMode } = useSharedPluginStateWithSelector(
    editorApi,
    ['contentFormat'],
    (states) => ({
      contentMode: states.contentFormatState?.contentMode,
    })
  );

  return <div>Current mode: {contentMode}</div>;
};
```

### Updating Content Mode

Products and plugins can update the content mode using the `updateContentMode` command:

```typescript
api.contentFormat?.commands.updateContentMode('compact');
```

## Plugin API

### Configuration Options

```typescript
type ContentFormatPluginOptions = {
  initialContentMode?: EditorContentMode; // Defaults to 'standard'
};
```

### Shared State

```typescript
type ContentFormatPluginState = {
  contentMode: EditorContentMode;
};
```

### Commands

#### `updateContentMode(mode: EditorContentMode)`

Updates the current content mode. The command will:
- Return `null` if the new mode is identical to the previous mode (no-op for performance)
- Set the meta on the transaction with the new content mode
- Trigger state updates across all dependent plugins

**Parameters:**
- `mode` (EditorContentMode): The new content mode to set

**Returns:** EditorCommand (null if no change needed, or the transaction with meta)

**Example:**
```typescript
api.contentFormat?.commands.updateContentMode('dense');
```

## 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-content-format · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
