@atlaskit/editor-plugin-toolbar 3.3.0 → 3.3.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-toolbar
 
+## 3.3.1
+
+### Patch Changes
+
+- [`916133ef0c6dd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/916133ef0c6dd) -
+  [ux] Editor experience tracking foundation
+- [`4f5569bde5e64`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4f5569bde5e64) -
+  Add new 'dragHandleSelected' user intent, use this to control table toolbar when drag handle is
+  selected
+- Updated dependencies
+
 ## 3.3.0
 
 ### Minor Changes
@@ -285,7 +296,6 @@
 
 - [`286abb4d35eba`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/286abb4d35eba) -
   [ux] [ED-28960] Finish full page primary toolbar migration
-
   - Align with design update (separator, gap, height, icon size)
   - Add keyboard shortcut to focus toolbar and arrow key navigation
   - Address accessibility
@@ -323,7 +333,6 @@
 
 - [`3145f278b1f7a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3145f278b1f7a) -
   [ux] [ED-28473] minor UI updates for editor-toolbar
-
   - Use ADS ButtonGroup for ToolbarButtonGroup
   - Remove groupLocation prop and use CSS instead
   - Use DropdownItemGroup for ToolbarDropdownItemSection and expand props for section separator and
@@ -355,7 +364,6 @@
   [`22cab8325fc62`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/22cab8325fc62) -
   [ux] [ED-28760] Fix editor lose focus and hence editing flow is interrupted. This is done for 2
   components
-
   - Dropdown
     - Create context ToolbarUIContext for toolbar consumers to access consumer specific state and
       callbacks

package/dist/cjs/pm-plugins/experiences/ContextualToolbarOpenExperience.js

@@ -0,0 +1,73 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _experiences = require("@atlaskit/editor-common/experiences");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _state = require("@atlaskit/editor-prosemirror/state");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var pluginKey = new _state.PluginKey('contextualToolbarOpenExperience');
+var _default = exports.default = function _default() {
+  var contextualToolbarOpenExperience = new _experiences.Experience('platform-editor-contextual-toolbar-open-experience', {
+    checks: [new _experiences.ExperienceCheckTimeout(500), new _experiences.ExperienceCheckDomMutation({
+      onDomMutation: function onDomMutation(_ref) {
+        var mutations = _ref.mutations;
+        if (mutations.some(isMutationAddingContextualToolbar)) {
+          return {
+            status: 'success'
+          };
+        }
+      },
+      observeConfig: function observeConfig() {
+        return {
+          target: document.body,
+          options: {
+            childList: true,
+            subtree: true
+          }
+        };
+      }
+    })]
+  });
+  return new _safePlugin.SafePlugin({
+    key: pluginKey,
+    state: {
+      init: function init() {
+        return {
+          shouldShowContextualToolbar: false
+        };
+      },
+      apply: function apply(_tr, pluginState, _, newState) {
+        var isTextSelection = newState.selection instanceof _state.TextSelection;
+        var isNotEmptySelection = !newState.selection.empty;
+        var shouldShowContextualToolbar = isTextSelection && isNotEmptySelection;
+        if (shouldShowContextualToolbar && !pluginState.shouldShowContextualToolbar) {
+          contextualToolbarOpenExperience.start();
+        } else if (!shouldShowContextualToolbar && pluginState.shouldShowContextualToolbar) {
+          contextualToolbarOpenExperience.abort();
+        }
+        return _objectSpread(_objectSpread({}, pluginState), {}, {
+          shouldShowContextualToolbar: shouldShowContextualToolbar
+        });
+      }
+    },
+    view: function view() {
+      return {
+        destroy: function destroy() {
+          contextualToolbarOpenExperience.abort();
+        }
+      };
+    }
+  });
+};
+var isMutationAddingContextualToolbar = function isMutationAddingContextualToolbar(mutation) {
+  return mutation.type === 'childList' && Array.from(mutation.addedNodes).some(nodeIncludesContextualToolbar);
+};
+var nodeIncludesContextualToolbar = function nodeIncludesContextualToolbar(node) {
+  return node instanceof HTMLElement && node.getAttribute('data-testid') === 'popup-wrapper' && node.querySelector('[data-testid="text-section"]');
+};

package/dist/cjs/toolbarPlugin.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.toolbarPlugin = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _react = _interopRequireDefault(require("react"));
 var _bindEventListener = require("bind-event-listener");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
@@ -14,6 +15,7 @@ var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _editorToolbarModel = require("@atlaskit/editor-toolbar-model");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
+var _ContextualToolbarOpenExperience = _interopRequireDefault(require("./pm-plugins/experiences/ContextualToolbarOpenExperience"));
 var _pluginKey = require("./pm-plugins/plugin-key");
 var _consts = require("./ui/consts");
 var _SelectionToolbar = require("./ui/SelectionToolbar");
@@ -177,7 +179,12 @@ var toolbarPlugin = exports.toolbarPlugin = function toolbarPlugin(_ref) {
             }
           });
         }
-      }];
+      }].concat((0, _toConsumableArray2.default)((0, _expValEquals.expValEquals)('platform_editor_experience_tracking', 'isEnabled', true) ? [{
+        name: 'contextualToolbarOpenExperience',
+        plugin: function plugin() {
+          return (0, _ContextualToolbarOpenExperience.default)();
+        }
+      }] : []));
     },
     contentComponent: !disableSelectionToolbar ? function (_ref2) {
       var editorView = _ref2.editorView,

package/dist/cjs/ui/SelectionToolbar/index.js

@@ -137,7 +137,9 @@ var SelectionToolbar = exports.SelectionToolbar = function SelectionToolbar(_ref
   if ((0, _expValEquals.expValEquals)('platform_editor_toolbar_aifc_template_editor', 'isEnabled', true) && editorToolbarDockingPreference === 'top' && disableSelectionToolbarWhenPinned || !components || !toolbar) {
     return null;
   }
-  if (!(isTextSelection || isCellSelection || isAllSelection) || currentUserIntent === 'dragging' || !shouldShowToolbar || currentUserIntent === 'blockMenuOpen' && (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu', 'isEnabled', true) || currentUserIntent && currentUserIntent !== 'default' || (0, _coreUtils.isSSR)()) {
+  if (!(isTextSelection || isCellSelection || isAllSelection) || currentUserIntent === 'dragging' || !shouldShowToolbar || currentUserIntent === 'blockMenuOpen' && (0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_block_menu', 'isEnabled', true) || ((0, _platformFeatureFlags.fg)('platform_editor_toolbar_aifc_user_intent_fix') ?
+  // hide toolbar when user intent is not default, except when it's dragHandleSelected without cell selection
+  currentUserIntent && currentUserIntent !== 'default' && !(currentUserIntent === 'dragHandleSelected' && !isCellSelection) : currentUserIntent && currentUserIntent !== 'default') || (0, _coreUtils.isSSR)()) {
     return null;
   }
   return /*#__PURE__*/_react.default.createElement(_ui.Popup, {

package/dist/es2019/pm-plugins/experiences/ContextualToolbarOpenExperience.js

@@ -0,0 +1,61 @@
+import { Experience, ExperienceCheckDomMutation, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
+const pluginKey = new PluginKey('contextualToolbarOpenExperience');
+export default (() => {
+  const contextualToolbarOpenExperience = new Experience('platform-editor-contextual-toolbar-open-experience', {
+    checks: [new ExperienceCheckTimeout(500), new ExperienceCheckDomMutation({
+      onDomMutation: ({
+        mutations
+      }) => {
+        if (mutations.some(isMutationAddingContextualToolbar)) {
+          return {
+            status: 'success'
+          };
+        }
+      },
+      observeConfig: () => ({
+        target: document.body,
+        options: {
+          childList: true,
+          subtree: true
+        }
+      })
+    })]
+  });
+  return new SafePlugin({
+    key: pluginKey,
+    state: {
+      init: () => ({
+        shouldShowContextualToolbar: false
+      }),
+      apply: (_tr, pluginState, _, newState) => {
+        const isTextSelection = newState.selection instanceof TextSelection;
+        const isNotEmptySelection = !newState.selection.empty;
+        const shouldShowContextualToolbar = isTextSelection && isNotEmptySelection;
+        if (shouldShowContextualToolbar && !pluginState.shouldShowContextualToolbar) {
+          contextualToolbarOpenExperience.start();
+        } else if (!shouldShowContextualToolbar && pluginState.shouldShowContextualToolbar) {
+          contextualToolbarOpenExperience.abort();
+        }
+        return {
+          ...pluginState,
+          shouldShowContextualToolbar
+        };
+      }
+    },
+    view: () => {
+      return {
+        destroy: () => {
+          contextualToolbarOpenExperience.abort();
+        }
+      };
+    }
+  });
+});
+const isMutationAddingContextualToolbar = mutation => {
+  return mutation.type === 'childList' && Array.from(mutation.addedNodes).some(nodeIncludesContextualToolbar);
+};
+const nodeIncludesContextualToolbar = node => {
+  return node instanceof HTMLElement && node.getAttribute('data-testid') === 'popup-wrapper' && node.querySelector('[data-testid="text-section"]');
+};

package/dist/es2019/toolbarPlugin.js

@@ -2,10 +2,11 @@ import React from 'react';
 import { bind } from 'bind-event-listener';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
-import { findSelectedNodeOfType, findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { findParentNodeOfType, findSelectedNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { createComponentRegistry } from '@atlaskit/editor-toolbar-model';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import contextualToolbarOpenExperience from './pm-plugins/experiences/ContextualToolbarOpenExperience';
 import { editorToolbarPluginKey } from './pm-plugins/plugin-key';
 import { DEFAULT_POPUP_SELECTORS } from './ui/consts';
 import { SelectionToolbar, SelectionToolbarWithErrorBoundary } from './ui/SelectionToolbar';
@@ -169,7 +170,10 @@ export const toolbarPlugin = ({
             }
           });
         }
-      }];
+      }, ...(expValEquals('platform_editor_experience_tracking', 'isEnabled', true) ? [{
+        name: 'contextualToolbarOpenExperience',
+        plugin: () => contextualToolbarOpenExperience()
+      }] : [])];
     },
     contentComponent: !disableSelectionToolbar ? ({
       editorView,

package/dist/es2019/ui/SelectionToolbar/index.js

@@ -128,7 +128,9 @@ export const SelectionToolbar = ({
   if (expValEquals('platform_editor_toolbar_aifc_template_editor', 'isEnabled', true) && editorToolbarDockingPreference === 'top' && disableSelectionToolbarWhenPinned || !components || !toolbar) {
     return null;
   }
-  if (!(isTextSelection || isCellSelection || isAllSelection) || currentUserIntent === 'dragging' || !shouldShowToolbar || currentUserIntent === 'blockMenuOpen' && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) || currentUserIntent && currentUserIntent !== 'default' || isSSR()) {
+  if (!(isTextSelection || isCellSelection || isAllSelection) || currentUserIntent === 'dragging' || !shouldShowToolbar || currentUserIntent === 'blockMenuOpen' && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) || (fg('platform_editor_toolbar_aifc_user_intent_fix') ?
+  // hide toolbar when user intent is not default, except when it's dragHandleSelected without cell selection
+  currentUserIntent && currentUserIntent !== 'default' && !(currentUserIntent === 'dragHandleSelected' && !isCellSelection) : currentUserIntent && currentUserIntent !== 'default') || isSSR()) {
     return null;
   }
   return /*#__PURE__*/React.createElement(Popup, {

package/dist/esm/pm-plugins/experiences/ContextualToolbarOpenExperience.js

@@ -0,0 +1,66 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { Experience, ExperienceCheckDomMutation, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
+var pluginKey = new PluginKey('contextualToolbarOpenExperience');
+export default (function () {
+  var contextualToolbarOpenExperience = new Experience('platform-editor-contextual-toolbar-open-experience', {
+    checks: [new ExperienceCheckTimeout(500), new ExperienceCheckDomMutation({
+      onDomMutation: function onDomMutation(_ref) {
+        var mutations = _ref.mutations;
+        if (mutations.some(isMutationAddingContextualToolbar)) {
+          return {
+            status: 'success'
+          };
+        }
+      },
+      observeConfig: function observeConfig() {
+        return {
+          target: document.body,
+          options: {
+            childList: true,
+            subtree: true
+          }
+        };
+      }
+    })]
+  });
+  return new SafePlugin({
+    key: pluginKey,
+    state: {
+      init: function init() {
+        return {
+          shouldShowContextualToolbar: false
+        };
+      },
+      apply: function apply(_tr, pluginState, _, newState) {
+        var isTextSelection = newState.selection instanceof TextSelection;
+        var isNotEmptySelection = !newState.selection.empty;
+        var shouldShowContextualToolbar = isTextSelection && isNotEmptySelection;
+        if (shouldShowContextualToolbar && !pluginState.shouldShowContextualToolbar) {
+          contextualToolbarOpenExperience.start();
+        } else if (!shouldShowContextualToolbar && pluginState.shouldShowContextualToolbar) {
+          contextualToolbarOpenExperience.abort();
+        }
+        return _objectSpread(_objectSpread({}, pluginState), {}, {
+          shouldShowContextualToolbar: shouldShowContextualToolbar
+        });
+      }
+    },
+    view: function view() {
+      return {
+        destroy: function destroy() {
+          contextualToolbarOpenExperience.abort();
+        }
+      };
+    }
+  });
+});
+var isMutationAddingContextualToolbar = function isMutationAddingContextualToolbar(mutation) {
+  return mutation.type === 'childList' && Array.from(mutation.addedNodes).some(nodeIncludesContextualToolbar);
+};
+var nodeIncludesContextualToolbar = function nodeIncludesContextualToolbar(node) {
+  return node instanceof HTMLElement && node.getAttribute('data-testid') === 'popup-wrapper' && node.querySelector('[data-testid="text-section"]');
+};

package/dist/esm/toolbarPlugin.js

@@ -1,14 +1,16 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import React from 'react';
 import { bind } from 'bind-event-listener';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
-import { findSelectedNodeOfType, findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+import { findParentNodeOfType, findSelectedNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { createComponentRegistry } from '@atlaskit/editor-toolbar-model';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import contextualToolbarOpenExperience from './pm-plugins/experiences/ContextualToolbarOpenExperience';
 import { editorToolbarPluginKey } from './pm-plugins/plugin-key';
 import { DEFAULT_POPUP_SELECTORS } from './ui/consts';
 import { SelectionToolbar, SelectionToolbarWithErrorBoundary } from './ui/SelectionToolbar';
@@ -170,7 +172,12 @@ export var toolbarPlugin = function toolbarPlugin(_ref) {
             }
           });
         }
-      }];
+      }].concat(_toConsumableArray(expValEquals('platform_editor_experience_tracking', 'isEnabled', true) ? [{
+        name: 'contextualToolbarOpenExperience',
+        plugin: function plugin() {
+          return contextualToolbarOpenExperience();
+        }
+      }] : []));
     },
     contentComponent: !disableSelectionToolbar ? function (_ref2) {
       var editorView = _ref2.editorView,

package/dist/esm/ui/SelectionToolbar/index.js

@@ -129,7 +129,9 @@ export var SelectionToolbar = function SelectionToolbar(_ref) {
   if (expValEquals('platform_editor_toolbar_aifc_template_editor', 'isEnabled', true) && editorToolbarDockingPreference === 'top' && disableSelectionToolbarWhenPinned || !components || !toolbar) {
     return null;
   }
-  if (!(isTextSelection || isCellSelection || isAllSelection) || currentUserIntent === 'dragging' || !shouldShowToolbar || currentUserIntent === 'blockMenuOpen' && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) || currentUserIntent && currentUserIntent !== 'default' || isSSR()) {
+  if (!(isTextSelection || isCellSelection || isAllSelection) || currentUserIntent === 'dragging' || !shouldShowToolbar || currentUserIntent === 'blockMenuOpen' && expValEqualsNoExposure('platform_editor_block_menu', 'isEnabled', true) || (fg('platform_editor_toolbar_aifc_user_intent_fix') ?
+  // hide toolbar when user intent is not default, except when it's dragHandleSelected without cell selection
+  currentUserIntent && currentUserIntent !== 'default' && !(currentUserIntent === 'dragHandleSelected' && !isCellSelection) : currentUserIntent && currentUserIntent !== 'default') || isSSR()) {
     return null;
   }
   return /*#__PURE__*/React.createElement(Popup, {

package/dist/types/pm-plugins/experiences/ContextualToolbarOpenExperience.d.ts

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+declare const _default: () => SafePlugin<{
+    shouldShowContextualToolbar: boolean;
+}>;
+export default _default;

package/dist/types-ts4.5/pm-plugins/experiences/ContextualToolbarOpenExperience.d.ts

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+declare const _default: () => SafePlugin<{
+    shouldShowContextualToolbar: boolean;
+}>;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-toolbar",
-	"version": "3.3.0",
+	"version": "3.3.1",
 	"description": "Toolbar plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,7 +29,7 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/browser-apis": "^0.0.1",
-		"@atlaskit/editor-plugin-analytics": "^6.1.0",
+		"@atlaskit/editor-plugin-analytics": "^6.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^6.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^8.0.0",
 		"@atlaskit/editor-plugin-selection": "^6.1.0",
@@ -40,18 +40,21 @@
 		"@atlaskit/editor-toolbar-model": "^0.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/platform-feature-flags-react": "^0.3.0",
-		"@atlaskit/tmp-editor-statsig": "^13.10.0",
+		"@atlaskit/tmp-editor-statsig": "^13.16.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.12.0",
+		"@atlaskit/editor-common": "^110.15.0",
 		"react": "^18.2.0"
 	},
 	"platform-feature-flags": {
 		"platform_editor_toolbar_aifc_patch_7": {
 			"type": "boolean"
+		},
+		"platform_editor_toolbar_aifc_user_intent_fix": {
+			"type": "boolean"
 		}
 	},
 	"techstack": {