# @atlaskit/editor-plugin-user-preferences

> UserPreferences plugin for @atlaskit/editor-core

Latest version **27.0.3** (published 2026-10-22) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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.3 |
| Published | 2026-10-22 |
| First published | 2025-05-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 74.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

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

## Dependencies (5)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0
- [bind-event-listener](https://npm.io/package/bind-event-listener.md) ^3.0.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) ^245.0.0
- [@atlaskit/editor-plugin-analytics](https://npm.io/package/@atlaskit/editor-plugin-analytics.md) ^29.0.0

## Recent versions

- 27.0.3 (latest) — 2026-10-22
- 27.0.2 — 2026-10-21
- 27.0.1 — 2026-10-21
- 27.0.0 — 2026-10-20
- 26.0.2 — 2026-10-19
- 26.0.1 — 2026-10-19
- 26.0.0 — 2026-10-16
- 25.0.5 — 2026-10-14
- 25.0.4 — 2026-10-14
- 25.0.3 — 2026-10-14
- 25.0.2 — 2026-10-14
- 25.0.1 — 2026-10-13
- 25.0.0 — 2026-10-13
- 24.0.7 — 2026-10-13
- 24.0.5 — 2026-10-12
- … 258 more at https://npm.io/package/@atlaskit/editor-plugin-user-preferences/versions

## README

# Editor Plugin User Preferences

User Preferences 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 User Preferences plugin provides comprehensive user preference management capabilities for the Atlassian Editor. It integrates with a UserPreferencesProvider to capture, persist, and manage user preferences across editor sessions. The plugin supports preference updates, retrieval, and automatic synchronization with the editor state.

## Key features

- **Preference management** - Get and update user preferences with a consistent API
- **Persistent storage** - Optional integration with UserPreferencesProvider for preference persistence
- **In-memory mode** - Operates without a provider when persistence is not available
- **Event tracking** - Integration with analytics plugin for preference update tracking
- **Hooks integration** - React hooks for listening to preference changes and document visibility
- **Flexible configuration** - Configure initial preferences and provide a custom preferences provider

## Install

---

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

## Usage

---

**Internal use only**

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