# @atlaskit/editor-plugin-custom-autoformat

> Custom autoformat 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-custom-autoformat
pnpm add @atlaskit/editor-plugin-custom-autoformat
yarn add @atlaskit/editor-plugin-custom-autoformat
bun add @atlaskit/editor-plugin-custom-autoformat
```

## 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-12-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 72.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

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

## Dependencies (3)

- [@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
- [@atlaskit/prosemirror-history](https://npm.io/package/@atlaskit/prosemirror-history.md) ^1.3.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.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
- 19.0.0 — 2026-09-17
- … 73 more at https://npm.io/package/@atlaskit/editor-plugin-custom-autoformat/versions

## README

# Editor Plugin Custom Autoformat

Custom autoformat 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 Custom Autoformat plugin provides text pattern matching and replacement capabilities for the Atlassian Editor. It integrates with an autoformatting provider to detect user-defined text patterns and automatically replace them with formatted content, such as inline cards or transformed text nodes.

## Key features

- **Pattern matching** - Detect and match user-typed text patterns using customizable rules
- **Async replacement** - Asynchronously resolve pattern matches to replacement content
- **Provider-based rules** - Load autoformatting rules dynamically from an autoformatting provider
- **Soft break support** - Handle autoformatting correctly across soft line breaks
- **State management** - Track resolving and completed replacements with position remapping
- **History integration** - Properly integrate with ProseMirror history for undo/redo functionality

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

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

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