Editor Plugin Show Diff
Show Diff 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 Show Diff plugin provides visual diff visualization capabilities for the Atlassian Editor. It highlights changes made to document content by displaying additions, deletions, and modifications with configurable color schemes. The plugin integrates with ProseMirror to calculate and render diff decorations based on document steps.
Key features
- Visual diff highlighting - Display changes as inline, block, and widget decorations
- Multiple color schemes - Support for 'standard' (purple) and 'traditional' (green/red) highlighting
- Change navigation - Scroll through and navigate between different changes in the document
- Flexible configuration - Configurable color schemes and diff parameters
- ProseMirror integration - Works seamlessly with ProseMirror steps and transactions
Install
- Install - yarn add @atlaskit/editor-plugin-show-diff
- npm - @atlaskit/editor-plugin-show-diff
- Source - Bitbucket
- Bundle - unpkg.com
Usage
Internal use only
@atlaskit/editor-plugin-show-diff 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 show diff 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.