@atlaskit/editor-plugin-track-changes 25.0.5 → 25.0.7
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.
- package/CHANGELOG.md +12 -0
- package/dist/cjs/ui/TrackChangesToolbarButton.js +15 -13
- package/dist/cjs/ui/toolbar-components.js +12 -11
- package/dist/es2019/ui/TrackChangesToolbarButton.js +5 -3
- package/dist/es2019/ui/toolbar-components.js +2 -1
- package/dist/esm/ui/TrackChangesToolbarButton.js +5 -3
- package/dist/esm/ui/toolbar-components.js +2 -1
- package/dist/types/pm-plugins/keymaps.d.ts +1 -1
- package/dist/types/pm-plugins/main.d.ts +1 -1
- package/dist/types/trackChangesPluginType.d.ts +6 -5
- package/dist/types/ui/TrackChangesToolbarButton.d.ts +1 -1
- package/dist/types/ui/toolbar-components.d.ts +2 -2
- package/docs/0-intro.tsx +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -9,15 +9,17 @@ var _react = _interopRequireDefault(require("react"));
|
|
|
9
9
|
var _reactIntl = require("react-intl");
|
|
10
10
|
var _button = _interopRequireDefault(require("@atlaskit/button/icon/button"));
|
|
11
11
|
var _browser = require("@atlaskit/editor-common/browser");
|
|
12
|
-
var _hooks = require("@atlaskit/editor-common/hooks");
|
|
13
12
|
var _keymaps = require("@atlaskit/editor-common/keymaps");
|
|
14
|
-
var
|
|
15
|
-
var
|
|
13
|
+
var _trackChanges = require("@atlaskit/editor-common/messages/track-changes");
|
|
14
|
+
var _useSharedPluginStateWithSelector = require("@atlaskit/editor-common/useSharedPluginStateWithSelector");
|
|
15
|
+
var _historyIcon = require("@atlaskit/editor-toolbar/history-icon");
|
|
16
|
+
var _toolbarButton = require("@atlaskit/editor-toolbar/toolbar-button");
|
|
17
|
+
var _toolbarTooltip = require("@atlaskit/editor-toolbar/toolbar-tooltip");
|
|
16
18
|
var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref) {
|
|
17
19
|
var api = _ref.api,
|
|
18
20
|
Wrapper = _ref.wrapper;
|
|
19
21
|
var isToolbarAIFCEnabled = Boolean(api === null || api === void 0 ? void 0 : api.toolbar);
|
|
20
|
-
var _useSharedPluginState = (0,
|
|
22
|
+
var _useSharedPluginState = (0, _useSharedPluginStateWithSelector.useSharedPluginStateWithSelector)(api, ['trackChanges'], function (states) {
|
|
21
23
|
var _states$trackChangesS, _states$trackChangesS2, _states$trackChangesS3;
|
|
22
24
|
return {
|
|
23
25
|
isDisplayingChanges: (_states$trackChangesS = states.trackChangesState) === null || _states$trackChangesS === void 0 ? void 0 : _states$trackChangesS.isDisplayingChanges,
|
|
@@ -47,26 +49,26 @@ var TrackChangesToolbarButton = exports.TrackChangesToolbarButton = function Tra
|
|
|
47
49
|
// Exclude Firefox browser from showing keyboard shortcut in tooltip
|
|
48
50
|
var showShortcut = !browser.gecko;
|
|
49
51
|
var tooltipContent = showShortcut ? /*#__PURE__*/_react.default.createElement(_keymaps.ToolTipContent, {
|
|
50
|
-
description: formatMessage(
|
|
52
|
+
description: formatMessage(_trackChanges.trackChangesMessages.toolbarIconLabel),
|
|
51
53
|
keymap: _keymaps.toggleViewChanges
|
|
52
|
-
}) : formatMessage(
|
|
54
|
+
}) : formatMessage(_trackChanges.trackChangesMessages.toolbarIconLabel);
|
|
53
55
|
if (!isToolbarAIFCEnabled) {
|
|
54
|
-
return /*#__PURE__*/_react.default.createElement(
|
|
56
|
+
return /*#__PURE__*/_react.default.createElement(_toolbarTooltip.ToolbarTooltip, {
|
|
55
57
|
content: tooltipContent
|
|
56
58
|
}, /*#__PURE__*/_react.default.createElement(_button.default, {
|
|
57
|
-
icon:
|
|
58
|
-
label: formatMessage(
|
|
59
|
+
icon: _historyIcon.HistoryIcon,
|
|
60
|
+
label: formatMessage(_trackChanges.trackChangesMessages.toolbarIconLabel),
|
|
59
61
|
appearance: "subtle",
|
|
60
62
|
isDisabled: isDisabled,
|
|
61
63
|
isSelected: isDisplayingChanges,
|
|
62
64
|
onClick: handleClick
|
|
63
65
|
}));
|
|
64
66
|
}
|
|
65
|
-
var button = /*#__PURE__*/_react.default.createElement(
|
|
67
|
+
var button = /*#__PURE__*/_react.default.createElement(_toolbarTooltip.ToolbarTooltip, {
|
|
66
68
|
content: tooltipContent
|
|
67
|
-
}, /*#__PURE__*/_react.default.createElement(
|
|
68
|
-
iconBefore: /*#__PURE__*/_react.default.createElement(
|
|
69
|
-
label: formatMessage(
|
|
69
|
+
}, /*#__PURE__*/_react.default.createElement(_toolbarButton.ToolbarButton, {
|
|
70
|
+
iconBefore: /*#__PURE__*/_react.default.createElement(_historyIcon.HistoryIcon, {
|
|
71
|
+
label: formatMessage(_trackChanges.trackChangesMessages.toolbarIconLabel),
|
|
70
72
|
size: "small"
|
|
71
73
|
}),
|
|
72
74
|
onClick: handleClick,
|
|
@@ -6,24 +6,25 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
});
|
|
7
7
|
exports.getToolbarComponents = void 0;
|
|
8
8
|
var _react = _interopRequireDefault(require("react"));
|
|
9
|
-
var
|
|
9
|
+
var _keys = require("@atlaskit/editor-common/toolbar/keys");
|
|
10
|
+
var _rank = require("@atlaskit/editor-common/toolbar/rank");
|
|
10
11
|
var _TrackChangesToolbarButton = require("./TrackChangesToolbarButton");
|
|
11
12
|
var getToolbarComponents = exports.getToolbarComponents = function getToolbarComponents(api, options) {
|
|
12
13
|
return [{
|
|
13
|
-
type:
|
|
14
|
-
key:
|
|
14
|
+
type: _keys.TRACK_CHANGES_GROUP.type,
|
|
15
|
+
key: _keys.TRACK_CHANGES_GROUP.key,
|
|
15
16
|
parents: [{
|
|
16
|
-
type:
|
|
17
|
-
key:
|
|
18
|
-
rank:
|
|
17
|
+
type: _keys.TRACK_CHANGES_SECTION.type,
|
|
18
|
+
key: _keys.TRACK_CHANGES_SECTION.key,
|
|
19
|
+
rank: _rank.TRACK_CHANGES_SECTION_RANK[_keys.TRACK_CHANGES_GROUP.key]
|
|
19
20
|
}]
|
|
20
21
|
}, {
|
|
21
|
-
type:
|
|
22
|
-
key:
|
|
22
|
+
type: _keys.TRACK_CHANGES_BUTTON.type,
|
|
23
|
+
key: _keys.TRACK_CHANGES_BUTTON.key,
|
|
23
24
|
parents: [{
|
|
24
|
-
type:
|
|
25
|
-
key:
|
|
26
|
-
rank:
|
|
25
|
+
type: _keys.TRACK_CHANGES_GROUP.type,
|
|
26
|
+
key: _keys.TRACK_CHANGES_GROUP.key,
|
|
27
|
+
rank: _rank.TRACK_CHANGES_GROUP_RANK[_keys.TRACK_CHANGES_BUTTON.key]
|
|
27
28
|
}],
|
|
28
29
|
component: function component() {
|
|
29
30
|
return /*#__PURE__*/_react.default.createElement(_TrackChangesToolbarButton.TrackChangesToolbarButton, {
|
|
@@ -2,10 +2,12 @@ import React from 'react';
|
|
|
2
2
|
import { useIntl } from 'react-intl';
|
|
3
3
|
import IconButton from '@atlaskit/button/icon/button';
|
|
4
4
|
import { getBrowserInfo } from '@atlaskit/editor-common/browser';
|
|
5
|
-
import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
|
|
6
5
|
import { toggleViewChanges, ToolTipContent } from '@atlaskit/editor-common/keymaps';
|
|
7
|
-
import { trackChangesMessages } from '@atlaskit/editor-common/messages';
|
|
8
|
-
import {
|
|
6
|
+
import { trackChangesMessages } from '@atlaskit/editor-common/messages/track-changes';
|
|
7
|
+
import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/useSharedPluginStateWithSelector';
|
|
8
|
+
import { HistoryIcon } from '@atlaskit/editor-toolbar/history-icon';
|
|
9
|
+
import { ToolbarButton } from '@atlaskit/editor-toolbar/toolbar-button';
|
|
10
|
+
import { ToolbarTooltip } from '@atlaskit/editor-toolbar/toolbar-tooltip';
|
|
9
11
|
export const TrackChangesToolbarButton = ({
|
|
10
12
|
api,
|
|
11
13
|
wrapper: Wrapper
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
-
import { TRACK_CHANGES_BUTTON, TRACK_CHANGES_GROUP,
|
|
2
|
+
import { TRACK_CHANGES_BUTTON, TRACK_CHANGES_GROUP, TRACK_CHANGES_SECTION } from '@atlaskit/editor-common/toolbar/keys';
|
|
3
|
+
import { TRACK_CHANGES_SECTION_RANK, TRACK_CHANGES_GROUP_RANK } from '@atlaskit/editor-common/toolbar/rank';
|
|
3
4
|
import { TrackChangesToolbarButton } from './TrackChangesToolbarButton';
|
|
4
5
|
export const getToolbarComponents = (api, options) => {
|
|
5
6
|
return [{
|
|
@@ -2,10 +2,12 @@ import React from 'react';
|
|
|
2
2
|
import { useIntl } from 'react-intl';
|
|
3
3
|
import IconButton from '@atlaskit/button/icon/button';
|
|
4
4
|
import { getBrowserInfo } from '@atlaskit/editor-common/browser';
|
|
5
|
-
import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
|
|
6
5
|
import { toggleViewChanges, ToolTipContent } from '@atlaskit/editor-common/keymaps';
|
|
7
|
-
import { trackChangesMessages } from '@atlaskit/editor-common/messages';
|
|
8
|
-
import {
|
|
6
|
+
import { trackChangesMessages } from '@atlaskit/editor-common/messages/track-changes';
|
|
7
|
+
import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/useSharedPluginStateWithSelector';
|
|
8
|
+
import { HistoryIcon } from '@atlaskit/editor-toolbar/history-icon';
|
|
9
|
+
import { ToolbarButton } from '@atlaskit/editor-toolbar/toolbar-button';
|
|
10
|
+
import { ToolbarTooltip } from '@atlaskit/editor-toolbar/toolbar-tooltip';
|
|
9
11
|
export var TrackChangesToolbarButton = function TrackChangesToolbarButton(_ref) {
|
|
10
12
|
var api = _ref.api,
|
|
11
13
|
Wrapper = _ref.wrapper;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
-
import { TRACK_CHANGES_BUTTON, TRACK_CHANGES_GROUP,
|
|
2
|
+
import { TRACK_CHANGES_BUTTON, TRACK_CHANGES_GROUP, TRACK_CHANGES_SECTION } from '@atlaskit/editor-common/toolbar/keys';
|
|
3
|
+
import { TRACK_CHANGES_SECTION_RANK, TRACK_CHANGES_GROUP_RANK } from '@atlaskit/editor-common/toolbar/rank';
|
|
3
4
|
import { TrackChangesToolbarButton } from './TrackChangesToolbarButton';
|
|
4
5
|
export var getToolbarComponents = function getToolbarComponents(api, options) {
|
|
5
6
|
return [{
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
|
|
2
|
-
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
|
|
2
|
+
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-editor-plugin';
|
|
3
3
|
import type { TrackChangesPlugin } from '../trackChangesPluginType';
|
|
4
4
|
export declare function keymapPlugin(api?: ExtractInjectionAPI<TrackChangesPlugin>): SafePlugin;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
|
|
2
|
-
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
|
|
2
|
+
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-editor-plugin';
|
|
3
3
|
import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
|
|
4
4
|
import { PluginKey } from '@atlaskit/editor-prosemirror/state';
|
|
5
5
|
import type { TrackChangesPlugin } from '../trackChangesPluginType';
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import type { EditorCommand
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
1
|
+
import type { EditorCommand } from '@atlaskit/editor-common/types/editor-command';
|
|
2
|
+
import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types/next-editor-plugin';
|
|
3
|
+
import type { HistoryPlugin } from '@atlaskit/editor-plugin-history/historyPluginType';
|
|
4
|
+
import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar/primary-toolbar-plugin-type';
|
|
5
|
+
import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff/show-diff-plugin-type';
|
|
6
|
+
import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar/toolbar-plugin-type';
|
|
6
7
|
export interface TrackChangesPluginOptions {
|
|
7
8
|
/**
|
|
8
9
|
* Custom wrapper component for the track changes button.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
-
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
|
|
2
|
+
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-editor-plugin';
|
|
3
3
|
import type { TrackChangesPlugin } from '../trackChangesPluginType';
|
|
4
4
|
type TrackChangesToolbarButtonProps = {
|
|
5
5
|
api: ExtractInjectionAPI<TrackChangesPlugin> | undefined;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
|
|
2
|
-
import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
|
|
1
|
+
import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-editor-plugin';
|
|
2
|
+
import type { RegisterComponent } from '@atlaskit/editor-toolbar-model/types';
|
|
3
3
|
import type { TrackChangesPlugin, TrackChangesPluginOptions } from '../trackChangesPluginType';
|
|
4
4
|
export declare const getToolbarComponents: (api?: ExtractInjectionAPI<TrackChangesPlugin>, options?: TrackChangesPluginOptions) => RegisterComponent[];
|
package/docs/0-intro.tsx
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
|
|
3
3
|
import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
|
|
4
|
-
import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
|
|
4
|
+
import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils/editor-use-only';
|
|
5
5
|
import { token } from '@atlaskit/tokens';
|
|
6
6
|
|
|
7
7
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- md template from @atlaskit/docs
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-track-changes",
|
|
3
|
-
"version": "25.0.
|
|
3
|
+
"version": "25.0.7",
|
|
4
4
|
"description": "ShowDiff plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"@atlaskit/button": "^25.4.0",
|
|
29
29
|
"@atlaskit/editor-plugin-history": "26.0.0",
|
|
30
30
|
"@atlaskit/editor-plugin-primary-toolbar": "^27.0.0",
|
|
31
|
-
"@atlaskit/editor-plugin-show-diff": "24.1.
|
|
31
|
+
"@atlaskit/editor-plugin-show-diff": "24.1.4",
|
|
32
32
|
"@atlaskit/editor-plugin-toolbar": "^23.0.0",
|
|
33
33
|
"@atlaskit/editor-prosemirror": "^9.0.0",
|
|
34
34
|
"@atlaskit/editor-toolbar": "^2.8.0",
|