@atlaskit/editor-plugin-annotation 2.2.1 → 2.3.0

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 (8) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/cjs/pm-plugins/inline-comment.js +16 -3
  3. package/dist/cjs/pm-plugins/toolbar.js +1 -2
  4. package/dist/es2019/pm-plugins/inline-comment.js +16 -3
  5. package/dist/es2019/pm-plugins/toolbar.js +1 -2
  6. package/dist/esm/pm-plugins/inline-comment.js +16 -3
  7. package/dist/esm/pm-plugins/toolbar.js +1 -2
  8. package/package.json +5 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @atlaskit/editor-plugin-annotation
2
2
 
3
+ ## 2.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#138416](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/138416)
8
+ [`8cfce6829f775`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8cfce6829f775) -
9
+ Fix to have focussedCommentId render the standalone inlinecomment
10
+
11
+ ## 2.2.2
12
+
13
+ ### Patch Changes
14
+
15
+ - [#137627](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/137627)
16
+ [`ce160db6fb914`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ce160db6fb914) -
17
+ [ENGHEALTH-28514] Icongraphy uplift for editor-plugin-annotation
18
+ - Updated dependencies
19
+
3
20
  ## 2.2.1
4
21
 
5
22
  ### Patch Changes
package/dist/cjs/pm-plugins/inline-comment.js CHANGED
@@ -178,10 +178,23 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
178
178
  };
179
179
  var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
180
180
  var pluginState = (0, _utils.getPluginState)(editorView.state);
181
- if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && (0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks')) {
182
- (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
181
+ if ((0, _platformFeatureFlags.fg)('platform_editor_listen_for_focussed_query_param')) {
182
+ // When feature flag is true, only close if no annotationId
183
+ if (!annotationId) {
184
+ (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
185
+ } else {
186
+ (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
187
+ }
183
188
  } else {
184
- (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
189
+ // When feature flag is false, close if:
190
+ // 1. No annotationId OR
191
+ // 2. View is closed and annotation clicks are enabled
192
+ var shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && (0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks');
193
+ if (shouldClose) {
194
+ (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
195
+ } else {
196
+ (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
197
+ }
185
198
  }
186
199
  };
187
200
  var setHoveredAnnotationFn = function setHoveredAnnotationFn(annotationId) {
package/dist/cjs/pm-plugins/toolbar.js CHANGED
@@ -12,7 +12,6 @@ var _mediaSingle = require("@atlaskit/editor-common/media-single");
12
12
  var _messages = require("@atlaskit/editor-common/messages");
13
13
  var _utils = require("@atlaskit/editor-common/utils");
14
14
  var _comment = _interopRequireDefault(require("@atlaskit/icon/core/comment"));
15
- var _comment2 = _interopRequireDefault(require("@atlaskit/icon/glyph/comment"));
16
15
  var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
17
16
  var _editorCommands = require("../editor-commands");
18
17
  var _types = require("../types");
@@ -44,7 +43,7 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
44
43
  disabled: selectionValid === _types.AnnotationSelectionType.DISABLED || (api === null || api === void 0 || (_api$connectivity = api.connectivity) === null || _api$connectivity === void 0 || (_api$connectivity = _api$connectivity.sharedState) === null || _api$connectivity === void 0 || (_api$connectivity = _api$connectivity.currentState()) === null || _api$connectivity === void 0 ? void 0 : _api$connectivity.mode) === 'offline',
45
44
  testId: _types.AnnotationTestIds.floatingToolbarCreateButton,
46
45
  icon: _comment.default,
47
- iconFallback: _comment2.default,
46
+ iconFallback: _comment.default,
48
47
  tooltipContent: selectionValid === _types.AnnotationSelectionType.DISABLED ? commentDisabledMessage : /*#__PURE__*/_react.default.createElement(_keymaps.ToolTipContent, {
49
48
  description: createCommentMessage,
50
49
  keymap: _keymaps.addInlineComment
package/dist/es2019/pm-plugins/inline-comment.js CHANGED
@@ -110,10 +110,23 @@ export const inlineCommentPlugin = options => {
110
110
  const setVisibility = isVisible => onSetVisibility(editorView)(isVisible);
111
111
  const setSelectedAnnotationFn = annotationId => {
112
112
  const pluginState = getPluginState(editorView.state);
113
- if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && fg('platform_editor_listen_for_annotation_clicks')) {
114
- closeComponent()(editorView.state, editorView.dispatch);
113
+ if (fg('platform_editor_listen_for_focussed_query_param')) {
114
+ // When feature flag is true, only close if no annotationId
115
+ if (!annotationId) {
116
+ closeComponent()(editorView.state, editorView.dispatch);
117
+ } else {
118
+ setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
119
+ }
115
120
  } else {
116
- setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
121
+ // When feature flag is false, close if:
122
+ // 1. No annotationId OR
123
+ // 2. View is closed and annotation clicks are enabled
124
+ const shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && fg('platform_editor_listen_for_annotation_clicks');
125
+ if (shouldClose) {
126
+ closeComponent()(editorView.state, editorView.dispatch);
127
+ } else {
128
+ setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
129
+ }
117
130
  }
118
131
  };
119
132
  const setHoveredAnnotationFn = annotationId => {
package/dist/es2019/pm-plugins/toolbar.js CHANGED
@@ -5,7 +5,6 @@ import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
5
5
  import { annotationMessages } from '@atlaskit/editor-common/messages';
6
6
  import { calculateToolbarPositionAboveSelection, calculateToolbarPositionTrackHead, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
7
7
  import CommentIcon from '@atlaskit/icon/core/comment';
8
- import LegacyCommentIcon from '@atlaskit/icon/glyph/comment';
9
8
  import { fg } from '@atlaskit/platform-feature-flags';
10
9
  import { setInlineCommentDraftState } from '../editor-commands';
11
10
  import { AnnotationSelectionType, AnnotationTestIds } from '../types';
@@ -37,7 +36,7 @@ export const buildToolbar = editorAnalyticsAPI => ({
37
36
  disabled: selectionValid === AnnotationSelectionType.DISABLED || (api === null || api === void 0 ? void 0 : (_api$connectivity = api.connectivity) === null || _api$connectivity === void 0 ? void 0 : (_api$connectivity$sha = _api$connectivity.sharedState) === null || _api$connectivity$sha === void 0 ? void 0 : (_api$connectivity$sha2 = _api$connectivity$sha.currentState()) === null || _api$connectivity$sha2 === void 0 ? void 0 : _api$connectivity$sha2.mode) === 'offline',
38
37
  testId: AnnotationTestIds.floatingToolbarCreateButton,
39
38
  icon: CommentIcon,
40
- iconFallback: LegacyCommentIcon,
39
+ iconFallback: CommentIcon,
41
40
  tooltipContent: selectionValid === AnnotationSelectionType.DISABLED ? commentDisabledMessage : /*#__PURE__*/React.createElement(ToolTipContent, {
42
41
  description: createCommentMessage,
43
42
  keymap: addInlineComment
package/dist/esm/pm-plugins/inline-comment.js CHANGED
@@ -171,10 +171,23 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
171
171
  };
172
172
  var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
173
173
  var pluginState = getPluginState(editorView.state);
174
- if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && fg('platform_editor_listen_for_annotation_clicks')) {
175
- closeComponent()(editorView.state, editorView.dispatch);
174
+ if (fg('platform_editor_listen_for_focussed_query_param')) {
175
+ // When feature flag is true, only close if no annotationId
176
+ if (!annotationId) {
177
+ closeComponent()(editorView.state, editorView.dispatch);
178
+ } else {
179
+ setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
180
+ }
176
181
  } else {
177
- setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
182
+ // When feature flag is false, close if:
183
+ // 1. No annotationId OR
184
+ // 2. View is closed and annotation clicks are enabled
185
+ var shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && fg('platform_editor_listen_for_annotation_clicks');
186
+ if (shouldClose) {
187
+ closeComponent()(editorView.state, editorView.dispatch);
188
+ } else {
189
+ setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
190
+ }
178
191
  }
179
192
  };
180
193
  var setHoveredAnnotationFn = function setHoveredAnnotationFn(annotationId) {
package/dist/esm/pm-plugins/toolbar.js CHANGED
@@ -5,7 +5,6 @@ import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
5
5
  import { annotationMessages } from '@atlaskit/editor-common/messages';
6
6
  import { calculateToolbarPositionAboveSelection, calculateToolbarPositionTrackHead, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
7
7
  import CommentIcon from '@atlaskit/icon/core/comment';
8
- import LegacyCommentIcon from '@atlaskit/icon/glyph/comment';
9
8
  import { fg } from '@atlaskit/platform-feature-flags';
10
9
  import { setInlineCommentDraftState } from '../editor-commands';
11
10
  import { AnnotationSelectionType, AnnotationTestIds } from '../types';
@@ -37,7 +36,7 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
37
36
  disabled: selectionValid === AnnotationSelectionType.DISABLED || (api === null || api === void 0 || (_api$connectivity = api.connectivity) === null || _api$connectivity === void 0 || (_api$connectivity = _api$connectivity.sharedState) === null || _api$connectivity === void 0 || (_api$connectivity = _api$connectivity.currentState()) === null || _api$connectivity === void 0 ? void 0 : _api$connectivity.mode) === 'offline',
38
37
  testId: AnnotationTestIds.floatingToolbarCreateButton,
39
38
  icon: CommentIcon,
40
- iconFallback: LegacyCommentIcon,
39
+ iconFallback: CommentIcon,
41
40
  tooltipContent: selectionValid === AnnotationSelectionType.DISABLED ? commentDisabledMessage : /*#__PURE__*/React.createElement(ToolTipContent, {
42
41
  description: createCommentMessage,
43
42
  keymap: addInlineComment
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-annotation",
3
- "version": "2.2.1",
3
+ "version": "2.3.0",
4
4
  "description": "Annotation plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "dependencies": {
34
34
  "@atlaskit/adf-schema": "^47.6.0",
35
- "@atlaskit/editor-common": "^103.0.0",
35
+ "@atlaskit/editor-common": "^103.1.0",
36
36
  "@atlaskit/editor-plugin-analytics": "^2.2.0",
37
37
  "@atlaskit/editor-plugin-connectivity": "^2.0.0",
38
38
  "@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
@@ -110,6 +110,9 @@
110
110
  },
111
111
  "platform_editor_annotation_selected_annotation": {
112
112
  "type": "boolean"
113
+ },
114
+ "platform_editor_listen_for_focussed_query_param": {
115
+ "type": "boolean"
113
116
  }
114
117
  }
115
118
  }