@atlaskit/editor-plugin-mentions 18.2.4 → 18.2.6

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @atlaskit/editor-plugin-mentions
 
+## 18.2.6
+
+### Patch Changes
+
+- [`3ae04490ac0f4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3ae04490ac0f4) -
+  Render the disabled mention chip tooltip without React. Behind the
+  `platform_editor_use_vanilla_components` experiment, with no visual change.
+  - Disabled mention chips no longer mount a React tooltip, its portal, and the DOM-to-React event
+    bridge that fed it.
+  - Tooltips release their positioning instance when they close, rather than keeping one alive per
+    hovered chip.
+  - Tooltips remove their own element and attributes when destroyed, so mention and emoji chips no
+    longer leave orphaned popovers behind.
+  - Re-hovering a tooltip while it is closing keeps it open, matching `@atlaskit/tooltip`.
+    Previously the pending hide still landed and the tooltip disappeared under the pointer.
+  - Tooltips close when they hide, instead of waiting on a transition that nothing declares.
+    Required by the change above: releasing the positioning instance while the popover was still
+    open left it behind as an invisible hit target over the content.
+
+- Updated dependencies
+
+## 18.2.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 18.2.4
 
 ### Patch Changes

package/dist/cjs/nodeviews/mentionNodeView.js

@@ -11,6 +11,8 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _browser = require("@atlaskit/editor-common/browser");
+var _coreUtils = require("@atlaskit/editor-common/core-utils");
+var _vanillaTooltip = require("@atlaskit/editor-common/vanilla-tooltip");
 var _whitespace = require("@atlaskit/editor-common/whitespace");
 var _model = require("@atlaskit/editor-prosemirror/model");
 var _constants = require("@atlaskit/mention/constants");
@@ -29,6 +31,12 @@ var primitiveClassName = 'editor-mention-primitive';
 var primitiveWithAvatarClassName = 'editor-mention-primitive-with-avatar';
 var avatarContainerClassName = 'editor-mention-avatar';
 var mentionTextClassName = 'editor-mention-text';
+/**
+ * Classes applied to the disabled-reason tooltip. `ak-editor-vanilla-tooltip-default` opts into
+ * the shared `VanillaTooltip` look, defined as `vanillaTooltipDefaultStyles` in both
+ * EditorContentContainer stylesheets — keep them in sync when renaming.
+ */
+var disabledTooltipClassNames = 'ak-editor-vanilla-tooltip-default mention-disabled-tooltip';
 var genericMentionIds = ['HipChat', 'all', 'here'];
 var unknownMentionText = "@".concat(_constants.UNKNOWN_USER_ID);
 // eslint-disable-next-line require-unicode-regexp
@@ -291,6 +299,32 @@ var MentionNodeView = exports.MentionNodeView = /*#__PURE__*/function () {
         _this2.updateState(_this2.subscribedProvider);
       });
     }
+
+    /**
+     * Bind to `this.domElement`, the node-view wrapper. `VanillaTooltip` appends the popover to
+     * its trigger and listens for hover/focus there. This wrapper is also where `role`,
+     * `tabindex`, and aria are set, so `aria-describedby` belongs on it — not on the inner
+     * `.editor-mention-primitive` that the React tooltip still wraps.
+     */
+  }, {
+    key: "syncVanillaDisabledTooltip",
+    value: function syncVanillaDisabledTooltip(tooltipText) {
+      var _this$vanillaDisabled;
+      var trigger = this.domElement;
+      if (!trigger || tooltipText === this.vanillaDisabledTooltipText) {
+        return;
+      }
+
+      // A changed reason rebuilds rather than re-texting, so nothing out here has to reach into
+      // the element `VanillaTooltip` owns. `destroy()` takes that element with it.
+      (_this$vanillaDisabled = this.vanillaDisabledTooltip) === null || _this$vanillaDisabled === void 0 || _this$vanillaDisabled.destroy();
+      this.vanillaDisabledTooltip = undefined;
+      this.vanillaDisabledTooltipText = tooltipText;
+      if ((0, _coreUtils.isSSR)() || !tooltipText) {
+        return;
+      }
+      this.vanillaDisabledTooltip = new _vanillaTooltip.VanillaTooltip(trigger, tooltipText, undefined, disabledTooltipClassNames);
+    }
   }, {
     key: "syncDisabledTooltip",
     value: function syncDisabledTooltip(disabledState) {
@@ -298,6 +332,10 @@ var MentionNodeView = exports.MentionNodeView = /*#__PURE__*/function () {
       // branch on a truthy string instead of re-asserting non-null fields
       // off of `disabledState`.
       var tooltipText = disabledState !== null && disabledState !== void 0 && disabledState.disabled ? disabledState.tooltip : undefined;
+      if ((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_use_vanilla_components')) {
+        this.syncVanillaDisabledTooltip(tooltipText);
+        return;
+      }
       var chip = this.mentionPrimitiveElement;
       var portalProviderAPI = this.config.portalProviderAPI;
       if (!chip || !portalProviderAPI) {
@@ -473,6 +511,12 @@ var MentionNodeView = exports.MentionNodeView = /*#__PURE__*/function () {
       this.mentionAvatar = undefined;
       (_this$disabledTooltip = this.disabledTooltip) === null || _this$disabledTooltip === void 0 || _this$disabledTooltip.destroy();
       this.disabledTooltip = undefined;
+      if ((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_use_vanilla_components')) {
+        var _this$vanillaDisabled2;
+        (_this$vanillaDisabled2 = this.vanillaDisabledTooltip) === null || _this$vanillaDisabled2 === void 0 || _this$vanillaDisabled2.destroy();
+        this.vanillaDisabledTooltip = undefined;
+        this.vanillaDisabledTooltipText = undefined;
+      }
       (_this$unsubscribeFrom2 = this.unsubscribeFromDisabledStateChanges) === null || _this$unsubscribeFrom2 === void 0 || _this$unsubscribeFrom2.call(this);
       this.unsubscribeFromDisabledStateChanges = undefined;
       this.subscribedProvider = undefined;

package/dist/cjs/pm-plugins/main.js

@@ -74,7 +74,7 @@ var AI_STREAMING_TRANSFORMATION_META_KEY = 'isAIStreamingTransformation';
 var AGENT_MENTION_INACTIVITY_MS = 3000;
 var MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS = 20;
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "18.2.3";
+var PACKAGE_VERSION = "18.2.5";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {

package/dist/es2019/nodeviews/mentionNodeView.js

@@ -1,5 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { getBrowserInfo } from '@atlaskit/editor-common/browser';
+import { isSSR } from '@atlaskit/editor-common/core-utils';
+import { VanillaTooltip } from '@atlaskit/editor-common/vanilla-tooltip';
 import { ZERO_WIDTH_SPACE } from '@atlaskit/editor-common/whitespace';
 import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
 // oxlint-disable-next-line import/no-duplicates
@@ -18,6 +20,12 @@ const primitiveClassName = 'editor-mention-primitive';
 const primitiveWithAvatarClassName = 'editor-mention-primitive-with-avatar';
 const avatarContainerClassName = 'editor-mention-avatar';
 const mentionTextClassName = 'editor-mention-text';
+/**
+ * Classes applied to the disabled-reason tooltip. `ak-editor-vanilla-tooltip-default` opts into
+ * the shared `VanillaTooltip` look, defined as `vanillaTooltipDefaultStyles` in both
+ * EditorContentContainer stylesheets — keep them in sync when renaming.
+ */
+const disabledTooltipClassNames = 'ak-editor-vanilla-tooltip-default mention-disabled-tooltip';
 const genericMentionIds = ['HipChat', 'all', 'here'];
 const unknownMentionText = `@${UNKNOWN_USER_ID}`;
 // eslint-disable-next-line require-unicode-regexp
@@ -251,11 +259,39 @@ export class MentionNodeView {
       this.updateState(this.subscribedProvider);
     });
   }
+
+  /**
+   * Bind to `this.domElement`, the node-view wrapper. `VanillaTooltip` appends the popover to
+   * its trigger and listens for hover/focus there. This wrapper is also where `role`,
+   * `tabindex`, and aria are set, so `aria-describedby` belongs on it — not on the inner
+   * `.editor-mention-primitive` that the React tooltip still wraps.
+   */
+  syncVanillaDisabledTooltip(tooltipText) {
+    var _this$vanillaDisabled;
+    const trigger = this.domElement;
+    if (!trigger || tooltipText === this.vanillaDisabledTooltipText) {
+      return;
+    }
+
+    // A changed reason rebuilds rather than re-texting, so nothing out here has to reach into
+    // the element `VanillaTooltip` owns. `destroy()` takes that element with it.
+    (_this$vanillaDisabled = this.vanillaDisabledTooltip) === null || _this$vanillaDisabled === void 0 ? void 0 : _this$vanillaDisabled.destroy();
+    this.vanillaDisabledTooltip = undefined;
+    this.vanillaDisabledTooltipText = tooltipText;
+    if (isSSR() || !tooltipText) {
+      return;
+    }
+    this.vanillaDisabledTooltip = new VanillaTooltip(trigger, tooltipText, undefined, disabledTooltipClassNames);
+  }
   syncDisabledTooltip(disabledState) {
     // Capture the tooltip text into a local so the rest of the method can
     // branch on a truthy string instead of re-asserting non-null fields
     // off of `disabledState`.
     const tooltipText = disabledState !== null && disabledState !== void 0 && disabledState.disabled ? disabledState.tooltip : undefined;
+    if (isExperimentEnabled('platform_editor_use_vanilla_components')) {
+      this.syncVanillaDisabledTooltip(tooltipText);
+      return;
+    }
     const chip = this.mentionPrimitiveElement;
     const {
       portalProviderAPI
@@ -401,6 +437,12 @@ export class MentionNodeView {
     this.mentionAvatar = undefined;
     (_this$disabledTooltip = this.disabledTooltip) === null || _this$disabledTooltip === void 0 ? void 0 : _this$disabledTooltip.destroy();
     this.disabledTooltip = undefined;
+    if (isExperimentEnabled('platform_editor_use_vanilla_components')) {
+      var _this$vanillaDisabled2;
+      (_this$vanillaDisabled2 = this.vanillaDisabledTooltip) === null || _this$vanillaDisabled2 === void 0 ? void 0 : _this$vanillaDisabled2.destroy();
+      this.vanillaDisabledTooltip = undefined;
+      this.vanillaDisabledTooltipText = undefined;
+    }
     (_this$unsubscribeFrom2 = this.unsubscribeFromDisabledStateChanges) === null || _this$unsubscribeFrom2 === void 0 ? void 0 : _this$unsubscribeFrom2.call(this);
     this.unsubscribeFromDisabledStateChanges = undefined;
     this.subscribedProvider = undefined;

package/dist/es2019/pm-plugins/main.js

@@ -58,7 +58,7 @@ const AI_STREAMING_TRANSFORMATION_META_KEY = 'isAIStreamingTransformation';
 const AGENT_MENTION_INACTIVITY_MS = 3000;
 const MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS = 20;
 const PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-const PACKAGE_VERSION = "18.2.3";
+const PACKAGE_VERSION = "18.2.5";
 const setProvider = provider => (state, dispatch) => {
   if (dispatch) {
     dispatch(state.tr.setMeta(mentionPluginKey, {

package/dist/esm/nodeviews/mentionNodeView.js

@@ -6,6 +6,8 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 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 { getBrowserInfo } from '@atlaskit/editor-common/browser';
+import { isSSR } from '@atlaskit/editor-common/core-utils';
+import { VanillaTooltip } from '@atlaskit/editor-common/vanilla-tooltip';
 import { ZERO_WIDTH_SPACE } from '@atlaskit/editor-common/whitespace';
 import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
 // oxlint-disable-next-line import/no-duplicates
@@ -24,6 +26,12 @@ var primitiveClassName = 'editor-mention-primitive';
 var primitiveWithAvatarClassName = 'editor-mention-primitive-with-avatar';
 var avatarContainerClassName = 'editor-mention-avatar';
 var mentionTextClassName = 'editor-mention-text';
+/**
+ * Classes applied to the disabled-reason tooltip. `ak-editor-vanilla-tooltip-default` opts into
+ * the shared `VanillaTooltip` look, defined as `vanillaTooltipDefaultStyles` in both
+ * EditorContentContainer stylesheets — keep them in sync when renaming.
+ */
+var disabledTooltipClassNames = 'ak-editor-vanilla-tooltip-default mention-disabled-tooltip';
 var genericMentionIds = ['HipChat', 'all', 'here'];
 var unknownMentionText = "@".concat(UNKNOWN_USER_ID);
 // eslint-disable-next-line require-unicode-regexp
@@ -286,6 +294,32 @@ export var MentionNodeView = /*#__PURE__*/function () {
         _this2.updateState(_this2.subscribedProvider);
       });
     }
+
+    /**
+     * Bind to `this.domElement`, the node-view wrapper. `VanillaTooltip` appends the popover to
+     * its trigger and listens for hover/focus there. This wrapper is also where `role`,
+     * `tabindex`, and aria are set, so `aria-describedby` belongs on it — not on the inner
+     * `.editor-mention-primitive` that the React tooltip still wraps.
+     */
+  }, {
+    key: "syncVanillaDisabledTooltip",
+    value: function syncVanillaDisabledTooltip(tooltipText) {
+      var _this$vanillaDisabled;
+      var trigger = this.domElement;
+      if (!trigger || tooltipText === this.vanillaDisabledTooltipText) {
+        return;
+      }
+
+      // A changed reason rebuilds rather than re-texting, so nothing out here has to reach into
+      // the element `VanillaTooltip` owns. `destroy()` takes that element with it.
+      (_this$vanillaDisabled = this.vanillaDisabledTooltip) === null || _this$vanillaDisabled === void 0 || _this$vanillaDisabled.destroy();
+      this.vanillaDisabledTooltip = undefined;
+      this.vanillaDisabledTooltipText = tooltipText;
+      if (isSSR() || !tooltipText) {
+        return;
+      }
+      this.vanillaDisabledTooltip = new VanillaTooltip(trigger, tooltipText, undefined, disabledTooltipClassNames);
+    }
   }, {
     key: "syncDisabledTooltip",
     value: function syncDisabledTooltip(disabledState) {
@@ -293,6 +327,10 @@ export var MentionNodeView = /*#__PURE__*/function () {
       // branch on a truthy string instead of re-asserting non-null fields
       // off of `disabledState`.
       var tooltipText = disabledState !== null && disabledState !== void 0 && disabledState.disabled ? disabledState.tooltip : undefined;
+      if (isExperimentEnabled('platform_editor_use_vanilla_components')) {
+        this.syncVanillaDisabledTooltip(tooltipText);
+        return;
+      }
       var chip = this.mentionPrimitiveElement;
       var portalProviderAPI = this.config.portalProviderAPI;
       if (!chip || !portalProviderAPI) {
@@ -468,6 +506,12 @@ export var MentionNodeView = /*#__PURE__*/function () {
       this.mentionAvatar = undefined;
       (_this$disabledTooltip = this.disabledTooltip) === null || _this$disabledTooltip === void 0 || _this$disabledTooltip.destroy();
       this.disabledTooltip = undefined;
+      if (isExperimentEnabled('platform_editor_use_vanilla_components')) {
+        var _this$vanillaDisabled2;
+        (_this$vanillaDisabled2 = this.vanillaDisabledTooltip) === null || _this$vanillaDisabled2 === void 0 || _this$vanillaDisabled2.destroy();
+        this.vanillaDisabledTooltip = undefined;
+        this.vanillaDisabledTooltipText = undefined;
+      }
       (_this$unsubscribeFrom2 = this.unsubscribeFromDisabledStateChanges) === null || _this$unsubscribeFrom2 === void 0 || _this$unsubscribeFrom2.call(this);
       this.unsubscribeFromDisabledStateChanges = undefined;
       this.subscribedProvider = undefined;

package/dist/esm/pm-plugins/main.js

@@ -65,7 +65,7 @@ var AI_STREAMING_TRANSFORMATION_META_KEY = 'isAIStreamingTransformation';
 var AGENT_MENTION_INACTIVITY_MS = 3000;
 var MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS = 20;
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "18.2.3";
+var PACKAGE_VERSION = "18.2.5";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {

package/dist/types/nodeviews/mentionNodeView.d.ts

@@ -26,6 +26,8 @@ export declare class MentionNodeView implements NodeView {
     private hasAvatarSlot;
     private isDestroyed;
     private disabledTooltip;
+    private vanillaDisabledTooltip;
+    private vanillaDisabledTooltipText;
     private unsubscribeFromDisabledStateChanges;
     private subscribedProvider;
     constructor(node: PMNode, config: MentionNodeViewProps);
@@ -44,6 +46,13 @@ export declare class MentionNodeView implements NodeView {
      * `onChange` handler when the editor swaps providers.
      */
     private subscribeToProviderDisabledStateChanges;
+    /**
+     * Bind to `this.domElement`, the node-view wrapper. `VanillaTooltip` appends the popover to
+     * its trigger and listens for hover/focus there. This wrapper is also where `role`,
+     * `tabindex`, and aria are set, so `aria-describedby` belongs on it — not on the inner
+     * `.editor-mention-primitive` that the React tooltip still wraps.
+     */
+    private syncVanillaDisabledTooltip;
     private syncDisabledTooltip;
     private setTextContent;
     private setVisibleText;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "18.2.4",
+	"version": "18.2.6",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -47,7 +47,7 @@
 		"@atlaskit/section-message": "^10.2.0",
 		"@atlaskit/teams-app-config": "^3.0.0",
 		"@atlaskit/theme": "^28.2.0",
-		"@atlaskit/tmp-editor-statsig": "^171.0.0",
+		"@atlaskit/tmp-editor-statsig": "^172.0.0",
 		"@atlaskit/tokens": "^16.11.0",
 		"@atlaskit/tooltip": "^24.3.0",
 		"@atlaskit/user-picker": "^13.12.0",
@@ -59,7 +59,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.10.0",
+		"@atlaskit/editor-common": "^120.11.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"