@atlaskit/editor-plugin-undo-redo 8.0.24 → 8.0.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +38 -3
  3. package/dist/types/undoRedoPluginType.d.ts +1 -1
  4. package/dist/types-ts4.5/undoRedoPluginType.d.ts +1 -1
  5. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @atlaskit/editor-plugin-undo-redo
2
2
 
3
+ ## 8.0.26
4
+
5
+ ### Patch Changes
6
+
7
+ - [`7b7c52dff5d7d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b7c52dff5d7d) -
8
+ Fix eslint violations for type import syntax
9
+ - Updated dependencies
10
+
11
+ ## 8.0.25
12
+
13
+ ### Patch Changes
14
+
15
+ - [`9ff7d1c1aa288`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9ff7d1c1aa288) -
16
+ Update README.md and 0-intro.tsx
17
+ - Updated dependencies
18
+
3
19
  ## 8.0.24
4
20
 
5
21
  ### Patch Changes
package/README.md CHANGED
@@ -1,9 +1,44 @@
1
- # EditorPluginUndoRedo
1
+ # Editor Plugin Undo Redo
2
2
 
3
3
  Undo redo plugin for @atlaskit/editor-core
4
4
 
5
+ **Note:** This component is designed for internal Atlassian development.
6
+ External contributors will be able to use this component but will not be able to submit issues.
7
+
8
+ ## Overview
9
+
10
+ The Undo Redo plugin provides undo and redo functionality for the Atlassian Editor. It integrates with `@atlaskit/prosemirror-history` to manage document history, supports both keyboard shortcuts and toolbar buttons, and tracks user actions through analytics.
11
+
12
+ ## Key features
13
+
14
+ - **Undo and redo actions** - Revert or replay document changes
15
+ - **Keyboard shortcuts** - Support for standard undo/redo keyboard shortcuts
16
+ - **Toolbar buttons** - Optional toolbar UI components for undo/redo actions
17
+ - **Analytics tracking** - Track undo/redo actions and their sources
18
+ - **Configurable display** - Control toolbar button visibility
19
+ - **Multiple input sources** - Support keyboard, toolbar, and external invocations
20
+
21
+ ## Install
22
+ ---
23
+ - **Install** - *yarn add @atlaskit/editor-plugin-undo-redo*
24
+ - **npm** - [@atlaskit/editor-plugin-undo-redo](https://www.npmjs.com/package/@atlaskit/editor-plugin-undo-redo)
25
+ - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-undo-redo)
26
+ - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-undo-redo/dist/)
27
+
5
28
  ## Usage
29
+ ---
30
+ **Internal use only**
31
+
32
+ @atlaskit/editor-plugin-undo-redo is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
33
+
34
+ Direct use of this component is not supported.
35
+
36
+ Please see [Atlaskit - Editor plugin undo redo](https://atlaskit.atlassian.com/packages/editor/editor-plugin-undo-redo) for documentation and examples for this package.
6
37
 
7
- `import EditorPluginUndoRedo from '@atlaskit/editor-plugin-undo-redo';`
38
+ ## Support
39
+ ---
40
+ 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.
8
41
 
9
- Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-undo-redo).
42
+ ## License
43
+ ---
44
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
package/dist/types/undoRedoPluginType.d.ts CHANGED
@@ -4,7 +4,7 @@ import type { HistoryPlugin } from '@atlaskit/editor-plugin-history';
4
4
  import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
5
5
  import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
6
6
  import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
7
- import { type InputSource } from './pm-plugins/enums';
7
+ import type { InputSource } from './pm-plugins/enums';
8
8
  export type UndoRedoAction = (inputSource?: InputSource) => boolean;
9
9
  export type UndoRedoPlugin = NextEditorPlugin<'undoRedoPlugin', {
10
10
  actions: {
package/dist/types-ts4.5/undoRedoPluginType.d.ts CHANGED
@@ -4,7 +4,7 @@ import type { HistoryPlugin } from '@atlaskit/editor-plugin-history';
4
4
  import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
5
5
  import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
6
6
  import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
7
- import { type InputSource } from './pm-plugins/enums';
7
+ import type { InputSource } from './pm-plugins/enums';
8
8
  export type UndoRedoAction = (inputSource?: InputSource) => boolean;
9
9
  export type UndoRedoPlugin = NextEditorPlugin<'undoRedoPlugin', {
10
10
  actions: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-undo-redo",
3
- "version": "8.0.24",
3
+ "version": "8.0.26",
4
4
  "description": "Undo redo plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -39,7 +39,7 @@
39
39
  "@atlaskit/icon": "^34.0.0",
40
40
  "@atlaskit/platform-feature-flags": "^1.1.0",
41
41
  "@atlaskit/prosemirror-history": "^0.2.0",
42
- "@atlaskit/tmp-editor-statsig": "^57.0.0",
42
+ "@atlaskit/tmp-editor-statsig": "^58.0.0",
43
43
  "@babel/runtime": "^7.0.0",
44
44
  "@emotion/react": "^11.7.1"
45
45
  },