npm.io
33.0.0 • Published 2d ago

@atlaskit/editor-plugin-history

Licence
Apache-2.0
Version
33.0.0
Deps
4
Size
49 kB
Vulns
0
Weekly
0

Editor Plugin History

History 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 History plugin provides undo and redo functionality for the Atlassian Editor. It tracks document changes and manages the history state, allowing users to revert or reapply edits. The plugin integrates with ProseMirror's history system to monitor transaction history and expose undo/redo capabilities.

Key features

  • Undo/Redo tracking - Track and manage undo and redo state with canUndo and canRedo indicators
  • History slicing - Group multiple transactions into a single undo step using startHistorySlice and endHistorySlice commands
  • State management - Maintain history state with event counts for done and undone operations
  • Transaction monitoring - Automatically track document changes and update history state based on ProseMirror transactions

Install


Usage


Internal use only

@atlaskit/editor-plugin-history 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 history for documentation and examples for this package.

Support


For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.

License


Please see Atlassian Frontend - License for more licensing information.