@atlaskit/editor-plugin-quick-insert 29.0.4 → 30.0.1

package/dist/es2019/ui/registered-menu/TypeAheadQuickInsertMenu.js

@@ -0,0 +1,78 @@
+/* TypeAheadQuickInsertMenu.tsx generated by @compiled/babel-plugin v3.0.2 */
+import "./TypeAheadQuickInsertMenu.compiled.css";
+import { ax, ix } from "@compiled/react/runtime";
+import React, { useCallback } from 'react';
+import { RegisteredMenuList } from '@atlaskit/editor-common/registered-menu/list';
+import { Box } from '@atlaskit/primitives/compiled/box';
+import { getQuickInsertMenuItemId } from './getQuickInsertMenuItemId';
+import { QuickInsertEmptyState } from './QuickInsertEmptyState';
+const LIST_WIDTH = 320;
+const MENU_FOOTER_HEIGHT = 45;
+const MENU_FOOTER_HEIGHT_WITH_SCROLL_PADDING = 51;
+const styles = {
+  footer: "_1i531l7x _15a5nqa1 _uwhke4h9"
+};
+export const TypeAheadQuickInsertMenu = ({
+  Item,
+  rows,
+  activeItemKey,
+  itemCount,
+  listId,
+  listLabel,
+  maxHeight,
+  model,
+  onItemFocus,
+  onItemBlur,
+  onItemHover,
+  onItemLeave,
+  onItemVisibilityChange,
+  onRenderedItemsChange,
+  query = '',
+  selectedItemIndex,
+  hasScrollPadding = false
+}) => {
+  const footerItemIndex = itemCount - 1;
+  const onFooterItemHover = useCallback(() => onItemHover(footerItemIndex), [footerItemIndex, onItemHover]);
+  const getItemId = useCallback(({
+    itemIndex
+  }) => getQuickInsertMenuItemId(listId, itemIndex), [listId]);
+  if (!model.root) {
+    return null;
+  }
+  const listMaxHeight = Math.max(0, maxHeight - (model.footer ? hasScrollPadding ? MENU_FOOTER_HEIGHT_WITH_SCROLL_PADDING : MENU_FOOTER_HEIGHT : 0));
+  const hasListboxContent = rows.length > 0 || model.footer !== undefined;
+  return /*#__PURE__*/React.createElement(Box, {
+    "aria-label": hasListboxContent ? listLabel : undefined,
+    id: listId,
+    role: hasListboxContent ? 'listbox' : undefined
+  }, rows.length > 0 ? /*#__PURE__*/React.createElement(RegisteredMenuList, {
+    rows: rows,
+    Item: Item,
+    width: LIST_WIDTH,
+    maxHeight: listMaxHeight,
+    getItemId: getItemId,
+    activeItemKey: activeItemKey,
+    selectedItemIndex: selectedItemIndex,
+    scrollResetKey: query,
+    hasScrollPadding: hasScrollPadding,
+    scrollTo: "top-on-reset",
+    onItemFocus: onItemFocus,
+    onItemBlur: onItemBlur,
+    onItemHover: onItemHover,
+    onItemLeave: onItemLeave,
+    onItemVisibilityChange: onItemVisibilityChange,
+    onRenderedItemsChange: onRenderedItemsChange
+  }) : query !== '' && /*#__PURE__*/React.createElement(QuickInsertEmptyState, {
+    mode: "inline",
+    spacing: "spacious"
+  }), model.footer && /*#__PURE__*/React.createElement(Box, {
+    onMouseMove: onFooterItemHover,
+    paddingBlockEnd: hasScrollPadding ? 'space.075' : undefined,
+    xcss: styles.footer
+  }, /*#__PURE__*/React.createElement(Item, {
+    id: getQuickInsertMenuItemId(listId, footerItemIndex),
+    isSelected: selectedItemIndex === footerItemIndex,
+    isActive: false,
+    registration: model.footer
+  })));
+};

package/dist/es2019/ui/registered-menu/assets/no-results.js

@@ -0,0 +1,30 @@
+import React from 'react';
+export default function NoResultsIllustration({
+  height,
+  width
+}) {
+  return /*#__PURE__*/React.createElement("svg", {
+    width: width,
+    height: height,
+    viewBox: "0 0 57 63",
+    fill: "none",
+    xmlns: "http://www.w3.org/2000/svg",
+    "aria-hidden": "true",
+    focusable: "false"
+  }, /*#__PURE__*/React.createElement("path", {
+    fill: "#dddee1",
+    d: "M23.5 49.223c-5.196 0-10.166-1.955-14.442-5.814a30 30 0 0 1-3.545-3.85 29.6 29.6 0 0 1-2.868-4.456c-4.56-8.775-3.179-18.124 3.79-25.647a32.6 32.6 0 0 1 3.942-3.593 32 32 0 0 1 4.287-2.81c9.017-4.89 18.424-3.869 25.803 2.8a30.3 30.3 0 0 1 3.59 3.897 29.7 29.7 0 0 1 2.837 4.396C51.5 22.96 50.12 32.324 43.106 39.83a31.5 31.5 0 0 1-3.797 3.442 33 33 0 0 1-4.468 2.912c-3.777 2.03-7.62 3.036-11.341 3.036zm2.478-44.539c-2.957 0-6.02.824-9.082 2.489a28 28 0 0 0-3.658 2.396 27.5 27.5 0 0 0-3.37 3.07C4.24 18.711 3.15 25.92 6.798 32.941a25 25 0 0 0 2.42 3.75 25 25 0 0 0 2.981 3.24c5.866 5.299 13.119 6.054 20.427 2.13a27.4 27.4 0 0 0 3.818-2.492 27.5 27.5 0 0 0 3.24-2.936c5.658-6.054 6.741-13.27 3.06-20.318a25 25 0 0 0-2.39-3.698 25.3 25.3 0 0 0-3.021-3.289c-3.418-3.086-7.288-4.645-11.348-4.645z"
+  }), /*#__PURE__*/React.createElement("path", {
+    fill: "#dddee1",
+    d: "M42.822 42.291c-1.21-1.685-2.509-1.675-3.777-.694-1.19.92-1.507 2.164-.24 3.801l1.45 1.873 4.017-3.107z"
+  }), /*#__PURE__*/React.createElement("path", {
+    fill: "#dddee1",
+    d: "m45.28 43.385-6.03 4.663 11.332 14.657 6.03-4.663z"
+  }), /*#__PURE__*/React.createElement("path", {
+    fill: "#b7b9be",
+    d: "m44.31 44.134-4.091 3.163 3.843 4.97 4.091-3.163z"
+  }), /*#__PURE__*/React.createElement("path", {
+    fill: "#dddee1",
+    d: "M26.834 30.328h-3.42v-.217c-.116-2.432 1.264-5.066 3.227-6.143l.037-.02q.08-.042.154-.093c1.071-.69 1.68-1.88 1.643-3.189-.037-1.298-.707-2.439-1.791-3.052a4.5 4.5 0 0 0-2.21-.592c-2.315 0-4.198 1.897-4.198 4.229h-3.42c0-4.23 3.417-7.672 7.618-7.672a7.9 7.9 0 0 1 3.884 1.033c2.14 1.211 3.462 3.437 3.534 5.955.073 2.53-1.125 4.84-3.203 6.18q-.211.139-.424.251c-.815.458-1.497 1.868-1.434 2.97zM24.795 32.303a3.4 3.4 0 0 1 1.096-.004c1.115.183 2.021.965 2.241 2.182l.002.01.002.009a3.4 3.4 0 0 1-.002 1.103v.004c-.216 1.23-1.136 2.009-2.247 2.19a3.417 3.417 0 0 1-1.085-.003c-1.117-.18-2.027-.961-2.249-2.179l-.002-.01-.001-.01a3.3 3.3 0 0 1 0-1.095l.002-.01.001-.01c.223-1.223 1.137-1.992 2.24-2.177z"
+  }));
+}

package/dist/es2019/ui/registered-menu/get-quick-insert-menu-model.js

@@ -0,0 +1,191 @@
+import { ASK_ROVO_MENU_ITEM, MENU, SEARCH_RESULTS_SECTION } from '@atlaskit/editor-common/quick-insert/keys';
+import { applyRegisteredItemRanks } from '@atlaskit/editor-common/registered-menu/item-rank';
+import { isMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-is-menu-footer-section-key';
+import { isSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-is-section-overflow-item-key';
+import { getComponentIdentity, resolveSurface, willComponentRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
+import { QuickInsertSearchResultsSection } from './QuickInsertSearchResultsSection';
+const SEARCH_TOP_MATCH_LIMIT = 5;
+const SEARCH_RESULTS_HEADING = {
+  key: SEARCH_RESULTS_SECTION.key,
+  type: SEARCH_RESULTS_SECTION.type,
+  component: QuickInsertSearchResultsSection,
+  parents: [{
+    key: MENU.key,
+    type: MENU.type,
+    rank: 0
+  }]
+};
+const getParentRank = (component, parentKey) => {
+  var _component$parents$fi, _component$parents, _component$parents$fi2;
+  return (_component$parents$fi = (_component$parents = component.parents) === null || _component$parents === void 0 ? void 0 : (_component$parents$fi2 = _component$parents.find(parent => parent.key === parentKey)) === null || _component$parents$fi2 === void 0 ? void 0 : _component$parents$fi2.rank) !== null && _component$parents$fi !== void 0 ? _component$parents$fi : Number.MAX_SAFE_INTEGER;
+};
+const compareMatchedItems = (a, b) => a.sectionRank - b.sectionRank || a.score - b.score || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
+const compareSearchResults = (a, b) => a.score - b.score || a.sectionRank - b.sectionRank || a.itemRank - b.itemRank || a.sourceIndex - b.sourceIndex || a.identity.localeCompare(b.identity);
+const comparePrioritizedSearchResults = (a, b) => {
+  var _b$priorityGroup, _a$priorityGroup;
+  return ((_b$priorityGroup = b.priorityGroup) !== null && _b$priorityGroup !== void 0 ? _b$priorityGroup : 0) - ((_a$priorityGroup = a.priorityGroup) !== null && _a$priorityGroup !== void 0 ? _a$priorityGroup : 0) || compareSearchResults(a, b);
+};
+const getSearchResults = matches => {
+  const topMatches = Array.from(matches).sort(compareSearchResults).slice(0, SEARCH_TOP_MATCH_LIMIT);
+  const topMatchIdentities = new Set(topMatches.map(({
+    identity
+  }) => identity));
+  const tailMatches = matches.filter(({
+    identity
+  }) => !topMatchIdentities.has(identity));
+  return [...topMatches, ...tailMatches].map(({
+    item
+  }) => item);
+};
+const getRenderedMenuItems = (section, childrenMap, surfaceContext) => {
+  var _childrenMap$get;
+  return ((_childrenMap$get = childrenMap.get(getComponentIdentity(section))) !== null && _childrenMap$get !== void 0 ? _childrenMap$get : []).filter(child => child.type === 'menu-item' && willComponentRender(child, childrenMap, surfaceContext));
+};
+const buildBrowseSections = ({
+  childrenMap,
+  contentSections,
+  selectCategoryItems,
+  surfaceContext
+}) => {
+  const sections = [];
+  for (const section of contentSections) {
+    const children = getRenderedMenuItems(section, childrenMap, surfaceContext);
+    const overflowItems = children.filter(child => isSectionOverflowItemKey(child.key));
+    const viewMoreItem = overflowItems[overflowItems.length - 1];
+    const items = children.filter(child => !isSectionOverflowItemKey(child.key));
+    if (items.length === 0) {
+      continue;
+    }
+    const selectedItems = viewMoreItem !== undefined && selectCategoryItems !== undefined ? selectCategoryItems(items) : items;
+    if (selectedItems.length < items.length && viewMoreItem !== undefined) {
+      sections.push([section, ...selectedItems, viewMoreItem]);
+    } else {
+      sections.push([section, ...selectedItems]);
+    }
+  }
+  return {
+    fallbackItems: [],
+    sections
+  };
+};
+const buildSearchSections = ({
+  childrenMap,
+  components,
+  contentSections,
+  formatMessage,
+  query,
+  root,
+  surfaceContext
+}) => {
+  const matches = new Map();
+  const sourceIndexByComponent = new Map(components.map((component, index) => [component, index]));
+  for (const section of contentSections) {
+    for (const item of getRenderedMenuItems(section, childrenMap, surfaceContext)) {
+      var _item$match, _match$score, _sourceIndexByCompone;
+      if (isSectionOverflowItemKey(item.key)) {
+        continue;
+      }
+      const match = (_item$match = item.match) === null || _item$match === void 0 ? void 0 : _item$match.call(item, {
+        formatMessage,
+        itemKey: item.key,
+        query
+      });
+      if (item.match && match === null) {
+        continue;
+      }
+      const candidate = {
+        identity: `${item.type}:${item.key}`,
+        item,
+        itemRank: getParentRank(item, section.key),
+        priorityGroup: (match === null || match === void 0 ? void 0 : match.priorityGroup) !== undefined && Number.isFinite(match.priorityGroup) ? match.priorityGroup : undefined,
+        score: Math.min(1, Math.max(0, (_match$score = match === null || match === void 0 ? void 0 : match.score) !== null && _match$score !== void 0 ? _match$score : 0)),
+        sourceIndex: (_sourceIndexByCompone = sourceIndexByComponent.get(item)) !== null && _sourceIndexByCompone !== void 0 ? _sourceIndexByCompone : Number.MAX_SAFE_INTEGER,
+        sectionRank: getParentRank(section, root.key)
+      };
+      const existing = matches.get(candidate.identity);
+      if (!existing || compareMatchedItems(candidate, existing) < 0) {
+        matches.set(candidate.identity, candidate);
+      }
+    }
+  }
+  const uniqueMatches = Array.from(matches.values()).sort(compareMatchedItems);
+  const prioritizedMatches = uniqueMatches.filter(({
+    priorityGroup
+  }) => priorityGroup !== undefined);
+  const unprioritizedMatches = uniqueMatches.filter(({
+    priorityGroup
+  }) => priorityGroup === undefined);
+  const orderedSearchResults = [...prioritizedMatches.sort(comparePrioritizedSearchResults).map(({
+    item
+  }) => item), ...getSearchResults(unprioritizedMatches)];
+  if (orderedSearchResults.length > 0) {
+    return {
+      fallbackItems: [],
+      sections: [[SEARCH_RESULTS_HEADING, ...orderedSearchResults]]
+    };
+  }
+  const fallbackItem = contentSections.flatMap(section => {
+    var _childrenMap$get2;
+    return (_childrenMap$get2 = childrenMap.get(getComponentIdentity(section))) !== null && _childrenMap$get2 !== void 0 ? _childrenMap$get2 : [];
+  }).find(component => component.type === ASK_ROVO_MENU_ITEM.type && component.key === ASK_ROVO_MENU_ITEM.key && willComponentRender(component, childrenMap, surfaceContext));
+  return {
+    fallbackItems: fallbackItem ? [fallbackItem] : [],
+    sections: []
+  };
+};
+
+/**
+ * Builds the registered quick-insert menu model. An empty query browses every
+ * category; a non-empty query returns ranked matches. The footer is shared by both.
+ */
+export const getQuickInsertMenuModel = ({
+  components,
+  formatMessage,
+  getItemRank,
+  query,
+  rootComponent,
+  selectCategoryItems,
+  surfaceContext
+}) => {
+  const rankedComponents = applyRegisteredItemRanks(components, getItemRank);
+  const {
+    childrenMap,
+    root,
+    topLevelChildren = []
+  } = resolveSurface(rankedComponents, rootComponent);
+  if (!root || !willComponentRender(root, childrenMap, surfaceContext)) {
+    return {
+      fallbackItems: [],
+      footer: undefined,
+      root: undefined,
+      sections: []
+    };
+  }
+  const renderedSections = topLevelChildren.filter(section => section.type === 'menu-section' && willComponentRender(section, childrenMap, surfaceContext));
+  const footerSection = renderedSections.find(({
+    key
+  }) => isMenuFooterSectionKey(key));
+  const contentSections = renderedSections.filter(({
+    key
+  }) => !isMenuFooterSectionKey(key));
+  const content = query === '' ? buildBrowseSections({
+    childrenMap,
+    contentSections,
+    selectCategoryItems,
+    surfaceContext
+  }) : buildSearchSections({
+    childrenMap,
+    components: rankedComponents,
+    contentSections,
+    formatMessage,
+    query,
+    root,
+    surfaceContext
+  });
+  const footer = footerSection ? getRenderedMenuItems(footerSection, childrenMap, surfaceContext)[0] : undefined;
+  return {
+    ...content,
+    footer,
+    root
+  };
+};

package/dist/es2019/ui/registered-menu/getQuickInsertMenuItemId.js

@@ -0,0 +1 @@
+export const getQuickInsertMenuItemId = (listId, itemIndex) => `${listId}-${itemIndex}`;

package/dist/es2019/ui/registered-menu/selectQuickInsertCategoryItems.js

@@ -0,0 +1,19 @@
+import { quickInsertProviderMenuItemKey } from '@atlaskit/editor-common/quick-insert/get-provider-menu-item-key';
+const DEFAULT_ITEM_LIMIT = 30;
+const ECOSYSTEM_ITEM_LIMIT = 10;
+const isEcosystemQuickInsertItem = item => quickInsertProviderMenuItemKey.isEcosystem(item.key);
+
+/**
+ * Keeps the initial native and ecosystem results while ensuring ecosystem registrations
+ * remain discoverable beyond the default category item limit.
+ */
+export const selectQuickInsertCategoryItems = items => {
+  let ecosystemItemCount = 0;
+  return items.filter((item, index) => {
+    const isEcosystemItem = isEcosystemQuickInsertItem(item);
+    if (isEcosystemItem) {
+      ecosystemItemCount++;
+    }
+    return index < DEFAULT_ITEM_LIMIT || isEcosystemItem && ecosystemItemCount <= ECOSYSTEM_ITEM_LIMIT;
+  });
+};

package/dist/es2019/ui/registered-menu/useQuickInsertSearchAnalytics.js

@@ -0,0 +1,91 @@
+import { useCallback, useEffect, useRef } from 'react';
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics/types/enums';
+const SEARCH_DEBOUNCE_MS = 1000;
+export const useQuickInsertSearchAnalytics = ({
+  query,
+  resultCount,
+  surface,
+  category,
+  isOpen = true,
+  fireAnalyticsEvent
+}) => {
+  const latestOptions = useRef({
+    query,
+    resultCount,
+    surface,
+    category,
+    fireAnalyticsEvent
+  });
+  latestOptions.current = {
+    query,
+    resultCount,
+    surface,
+    category,
+    fireAnalyticsEvent
+  };
+  const pendingSearch = useRef(null);
+  const effectVersion = useRef(0);
+  const flush = useCallback(() => {
+    const pending = pendingSearch.current;
+    if (!pending) {
+      return;
+    }
+    clearTimeout(pending.timer);
+    pendingSearch.current = null;
+    const current = latestOptions.current;
+    if (current.query.trim() !== pending.query || !current.fireAnalyticsEvent) {
+      return;
+    }
+    const attributes = {
+      ...(current.surface === 'element-browser' && current.category !== undefined ? {
+        category: current.category
+      } : {}),
+      isEmpty: current.resultCount === 0,
+      queryLength: current.query.trim().length,
+      resultCount: current.resultCount,
+      surface: current.surface
+    };
+    const payload = {
+      action: ACTION.SEARCHED,
+      actionSubject: ACTION_SUBJECT.QUICK_INSERT,
+      eventType: EVENT_TYPE.TRACK,
+      attributes
+    };
+    current.fireAnalyticsEvent(payload);
+  }, []);
+  useEffect(() => {
+    const currentVersion = ++effectVersion.current;
+    if (!isOpen) {
+      flush();
+      return;
+    }
+    const trimmedQuery = query.trim();
+    if (!trimmedQuery) {
+      if (pendingSearch.current) {
+        clearTimeout(pendingSearch.current.timer);
+        pendingSearch.current = null;
+      }
+      return;
+    }
+    if (pendingSearch.current) {
+      clearTimeout(pendingSearch.current.timer);
+    }
+    const timer = setTimeout(flush, SEARCH_DEBOUNCE_MS);
+    pendingSearch.current = {
+      query: trimmedQuery,
+      timer
+    };
+    return () => {
+      if (pendingSearch.current) {
+        clearTimeout(pendingSearch.current.timer);
+      }
+      Promise.resolve().then(() => {
+        // oxlint-disable-next-line react-hooks/exhaustive-deps -- The live effect version distinguishes dependency cleanup from a real unmount.
+        if (effectVersion.current === currentVersion) {
+          flush();
+        }
+      });
+    };
+  }, [query, surface, category, isOpen, flush]);
+  return flush;
+};

package/dist/esm/quickInsertPlugin.js

@@ -8,6 +8,7 @@ import React from 'react';
 import { useIntl } from 'react-intl';
 import { isSSR } from '@atlaskit/editor-common/is-ssr';
 import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/messages/insert-block';
+import { MENU } from '@atlaskit/editor-common/quick-insert/keys';
 import { createQuickInsertRankResolver } from '@atlaskit/editor-common/quick-insert/quick-insert-rank';
 import { memoProcessQuickInsertItems } from '@atlaskit/editor-common/quick-insert/utils';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
@@ -37,6 +38,7 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
   var getItemRank = createQuickInsertRankResolver(options === null || options === void 0 ? void 0 : options.getItemRank);
   var typeAhead = {
     id: TypeAheadAvailableNodes.QUICK_INSERT,
+    registeredMenuKey: isExperimentEnabled('platform_editor_slash_command') ? MENU.key : undefined,
     getRegisteredItemRank: getItemRank,
     trigger: '/',
     // Support fullwidth slash (U+FF0F) used by Japanese/CJK keyboards (e.g. typing / on a Japanese keyboard layout)
@@ -78,12 +80,15 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
     } : undefined
   };
   if (isExperimentEnabled('platform_editor_slash_command')) {
-    var _api$uiControlRegistr;
+    var _api$uiControlRegistr, _api$analytics;
     api === null || api === void 0 || (_api$uiControlRegistr = api.uiControlRegistry) === null || _api$uiControlRegistr === void 0 || _api$uiControlRegistr.actions.register(getQuickInsertComponents({
       api: api,
-      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true,
+      getItemRank: getItemRank,
       isRecommendedItem: options === null || options === void 0 ? void 0 : options.isRecommendedItem,
-      maxRecommendedItems: options === null || options === void 0 ? void 0 : options.maxRecommendedItems
+      maxRecommendedItems: options === null || options === void 0 ? void 0 : options.maxRecommendedItems,
+      emptyStateHandler: options === null || options === void 0 ? void 0 : options.emptyStateHandler,
+      fireAnalyticsEvent: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent,
+      includeElementBrowserItems: (options === null || options === void 0 ? void 0 : options.enableElementBrowser) === true
     }));
   }
   if (isExperimentEnabled('platform_editor_block_control_migration') && (options === null || options === void 0 ? void 0 : options.blockControlButtonEnabled) !== false) {
@@ -142,8 +147,8 @@ export var quickInsertPlugin = function quickInsertPlugin(_ref) {
           return getQuickInsertOpenExperiencePlugin({
             refs: refs,
             dispatchAnalyticsEvent: function dispatchAnalyticsEvent(payload) {
-              var _api$analytics;
-              return api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 ? void 0 : _api$analytics.fireAnalyticsEvent(payload);
+              var _api$analytics2;
+              return api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || (_api$analytics2 = _api$analytics2.actions) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.fireAnalyticsEvent(payload);
             }
           });
         }

package/dist/esm/ui/QuickInsertRecommendedSlot.js

@@ -1,13 +1,16 @@
-import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["index", "getSnapshot"];
 import React from 'react';
 import { useQuickInsertContext } from '@atlaskit/editor-common/quick-insert/use-quick-insert-context';
 export var QuickInsertRecommendedSlot = function QuickInsertRecommendedSlot(_ref) {
-  var index = _ref.index,
-    getSnapshot = _ref.getSnapshot,
-    props = _objectWithoutProperties(_ref, _excluded);
+  var children = _ref.children,
+    parents = _ref.parents,
+    surfaceContext = _ref.surfaceContext,
+    index = _ref.index,
+    getSnapshot = _ref.getSnapshot;
   var _useQuickInsertContex = useQuickInsertContext(),
-    surfaceContext = _useQuickInsertContex.surfaceContext;
-  var item = getSnapshot(surfaceContext)[index];
-  return item !== null && item !== void 0 && item.component ? /*#__PURE__*/React.createElement(item.component, props) : null;
+    menuSurfaceContext = _useQuickInsertContex.surfaceContext;
+  var item = getSnapshot(menuSurfaceContext)[index];
+  return item !== null && item !== void 0 && item.component ? /*#__PURE__*/React.createElement(item.component, {
+    parents: parents,
+    surfaceContext: surfaceContext
+  }, children) : null;
 };

package/dist/esm/ui/RegistryElementBrowser/RegistryElementBrowser.js

@@ -11,7 +11,7 @@ import IconButton from '@atlaskit/button/icon/button';
 // eslint-disable-next-line @atlaskit/platform/no-barrel-entry-imports
 import { messages } from '@atlaskit/editor-common/quick-insert';
 import { MENU, RECOMMENDED_SECTION } from '@atlaskit/editor-common/quick-insert/keys';
-import { useQuickInsertSearchAnalytics } from '@atlaskit/editor-common/quick-insert/use-search-analytics';
+import { createRegisteredMenuSurfaceContext } from '@atlaskit/editor-common/registered-menu/surface-context';
 import { getMenuFooterSectionKey } from '@atlaskit/editor-common/type-ahead-get-menu-footer-section-key';
 import { getSectionOverflowItemKey } from '@atlaskit/editor-common/type-ahead-get-section-overflow-item-key';
 import Heading from '@atlaskit/heading/heading';
@@ -24,6 +24,7 @@ import ModalTitle from '@atlaskit/modal-dialog/modal-title';
 import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Textfield from '@atlaskit/textfield/text-field';
+import { useQuickInsertSearchAnalytics } from '../registered-menu/useQuickInsertSearchAnalytics';
 import { createRegistryElementBrowserModel, getInitialRegistryElementBrowserSection, getRegistryElementBrowserItems } from './model';
 import { RegistryElementBrowserCategories } from './RegistryElementBrowserCategories';
 import { RegistryElementBrowserFooter } from './RegistryElementBrowserFooter';
@@ -63,13 +64,34 @@ export var RegistryElementBrowser = function RegistryElementBrowser(_ref) {
     onSelect = _ref.onSelect;
   var _useIntl = useIntl(),
     formatMessage = _useIntl.formatMessage;
-  var _useState = useState({
+  var _useState = useState(function () {
+      return {
+        isOpen: isOpen,
+        menuOpenId: Symbol('element-browser')
+      };
+    }),
+    _useState2 = _slicedToArray(_useState, 2),
+    session = _useState2[0],
+    setSession = _useState2[1];
+  if (session.isOpen !== isOpen) {
+    setSession({
+      isOpen: isOpen,
+      menuOpenId: isOpen ? Symbol('element-browser') : session.menuOpenId
+    });
+  }
+  var surfaceContext = useMemo(function () {
+    return createRegisteredMenuSurfaceContext({
+      menuOpenId: session.menuOpenId,
+      surface: 'element-browser'
+    });
+  }, [session.menuOpenId]);
+  var _useState3 = useState({
       query: '',
       section: defaultSection
     }),
-    _useState2 = _slicedToArray(_useState, 2),
-    browserState = _useState2[0],
-    setBrowserState = _useState2[1];
+    _useState4 = _slicedToArray(_useState3, 2),
+    browserState = _useState4[0],
+    setBrowserState = _useState4[1];
   var query = browserState.query,
     section = browserState.section,
     selectedRegistration = browserState.selectedRegistration;
@@ -77,6 +99,7 @@ export var RegistryElementBrowser = function RegistryElementBrowser(_ref) {
   var browserModel = useMemo(function () {
     var model = createRegistryElementBrowserModel(components, {
       footerKey: getMenuFooterSectionKey(MENU.key),
+      surfaceContext: surfaceContext,
       overflowKeys: new Set(components.filter(function (component) {
         return component.type === 'menu-section';
       }).map(function (component) {
@@ -99,7 +122,7 @@ export var RegistryElementBrowser = function RegistryElementBrowser(_ref) {
         section: effectiveSection
       })
     };
-  }, [components, formatMessage, query, section]);
+  }, [components, formatMessage, query, section, surfaceContext]);
   var model = browserModel.model,
     effectiveSection = browserModel.effectiveSection,
     items = browserModel.items;
@@ -353,6 +376,7 @@ export var RegistryElementBrowser = function RegistryElementBrowser(_ref) {
     fallbackItems: model.fallbackItems,
     query: query,
     resultsId: resultsId,
+    surfaceContext: surfaceContext,
     section: effectiveSection,
     selectedKey: selectedKey,
     onKeyDown: onKeyDown,

package/dist/esm/ui/RegistryElementBrowser/RegistryElementBrowserSearchResults.js

@@ -3,9 +3,8 @@ import "./RegistryElementBrowserSearchResults.compiled.css";
 import { ax, ix } from "@compiled/react/runtime";
 import React, { useMemo } from 'react';
 import { useIntl } from 'react-intl';
-import { QuickInsertEmptyState } from '@atlaskit/editor-common/quick-insert/empty-state';
 import { QuickInsertProvider } from '@atlaskit/editor-common/quick-insert/provider';
-
+import { QuickInsertEmptyState } from '../registered-menu/QuickInsertEmptyState';
 // oxlint-disable-next-line eslint/no-redeclare
 
 var resultsGridStyles = null;
@@ -18,7 +17,8 @@ var RegistryElementBrowserItem = function RegistryElementBrowserItem(_ref) {
     isOffline = _ref.isOffline,
     isSelected = _ref.isSelected,
     item = _ref.item,
-    onSelect = _ref.onSelect;
+    onSelect = _ref.onSelect,
+    surfaceContext = _ref.surfaceContext;
   var _item$registration = item.registration,
     Component = _item$registration.component,
     key = _item$registration.key;
@@ -34,15 +34,18 @@ var RegistryElementBrowserItem = function RegistryElementBrowserItem(_ref) {
       select: function select(handler) {
         return onSelect(key, handler);
       },
-      surface: 'element-browser'
+      surfaceContext: surfaceContext
     };
-  }, [editorView, isOffline, isSelected, item.description, key, onSelect]);
+  }, [editorView, isOffline, isSelected, item.description, key, onSelect, surfaceContext]);
   if (!Component) {
     return null;
   }
   return /*#__PURE__*/React.createElement(QuickInsertProvider, {
     value: contextValue
-  }, /*#__PURE__*/React.createElement(Component, undefined, null));
+  }, /*#__PURE__*/React.createElement(Component, {
+    parents: item.registration.parents,
+    surfaceContext: surfaceContext
+  }, null));
 };
 export var RegistryElementBrowserSearchResults = function RegistryElementBrowserSearchResults(_ref2) {
   var editorView = _ref2.editorView,
@@ -56,6 +59,7 @@ export var RegistryElementBrowserSearchResults = function RegistryElementBrowser
     resultsId = _ref2.resultsId,
     section = _ref2.section,
     selectedKey = _ref2.selectedKey,
+    surfaceContext = _ref2.surfaceContext,
     onKeyDown = _ref2.onKeyDown,
     onSelect = _ref2.onSelect;
   var _useIntl = useIntl(),
@@ -96,7 +100,8 @@ export var RegistryElementBrowserSearchResults = function RegistryElementBrowser
       isSelected: selectedKey === item.registration.key,
       item: item,
       key: item.registration.key,
-      onSelect: onSelect
+      onSelect: onSelect,
+      surfaceContext: surfaceContext
     });
   })), shouldRenderEmptyState && !hasFallbackItems && query.trim().length > 0 && /*#__PURE__*/React.createElement(QuickInsertEmptyState, {
     mode: "full"