@atlaskit/editor-common 133.7.2 → 134.0.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 (142) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/insert/index.js +1 -0
  3. package/dist/cjs/monitoring/error.js +1 -1
  4. package/dist/cjs/quick-insert/QuickInsertContext.js +4 -0
  5. package/dist/cjs/quick-insert/QuickInsertMenuItem.js +4 -1
  6. package/dist/cjs/registered-menu/ActiveMenuItemKeyContext.js +11 -0
  7. package/dist/cjs/registered-menu/MeasuredRow.js +41 -0
  8. package/dist/cjs/registered-menu/RegisteredMenuContext.js +15 -0
  9. package/dist/cjs/registered-menu/RegisteredMenuList.js +224 -0
  10. package/dist/cjs/registered-menu/RegisteredMenuListItemRow.js +62 -0
  11. package/dist/cjs/registered-menu/RegisteredMenuSurfaceContext.js +12 -0
  12. package/dist/cjs/registered-menu/getRegisteredMenuRows.js +11 -0
  13. package/dist/cjs/registered-menu/types.js +5 -0
  14. package/dist/cjs/{quick-insert/use-menu-list-height.js → registered-menu/useMenuListHeight.js} +15 -11
  15. package/dist/cjs/{quick-insert/use-menu-popup-sizing.js → registered-menu/useMenuPopupSizing.js} +5 -1
  16. package/dist/cjs/registered-menu/useRegisteredMenu.js +133 -0
  17. package/dist/cjs/registered-menu/useRegisteredMenuSelection.js +53 -0
  18. package/dist/cjs/ui/DropList/index.js +1 -1
  19. package/dist/es2019/insert/index.js +3 -0
  20. package/dist/es2019/monitoring/error.js +1 -1
  21. package/dist/es2019/quick-insert/QuickInsertContext.js +4 -0
  22. package/dist/es2019/quick-insert/QuickInsertMenuItem.js +4 -1
  23. package/dist/es2019/registered-menu/ActiveMenuItemKeyContext.js +5 -0
  24. package/dist/es2019/registered-menu/MeasuredRow.js +32 -0
  25. package/dist/es2019/registered-menu/RegisteredMenuContext.js +9 -0
  26. package/dist/es2019/registered-menu/RegisteredMenuList.js +177 -0
  27. package/dist/es2019/registered-menu/RegisteredMenuListItemRow.js +47 -0
  28. package/dist/es2019/registered-menu/RegisteredMenuSurfaceContext.js +4 -0
  29. package/dist/es2019/registered-menu/getRegisteredMenuRows.js +1 -0
  30. package/dist/es2019/registered-menu/types.js +1 -0
  31. package/dist/es2019/{quick-insert/use-menu-list-height.js → registered-menu/useMenuListHeight.js} +14 -10
  32. package/dist/es2019/{quick-insert/use-menu-popup-sizing.js → registered-menu/useMenuPopupSizing.js} +5 -1
  33. package/dist/es2019/registered-menu/useRegisteredMenu.js +120 -0
  34. package/dist/es2019/registered-menu/useRegisteredMenuSelection.js +39 -0
  35. package/dist/es2019/ui/DropList/index.js +1 -1
  36. package/dist/esm/insert/index.js +3 -0
  37. package/dist/esm/monitoring/error.js +1 -1
  38. package/dist/esm/quick-insert/QuickInsertContext.js +4 -0
  39. package/dist/esm/quick-insert/QuickInsertMenuItem.js +4 -1
  40. package/dist/esm/registered-menu/ActiveMenuItemKeyContext.js +5 -0
  41. package/dist/esm/registered-menu/MeasuredRow.js +33 -0
  42. package/dist/esm/registered-menu/RegisteredMenuContext.js +9 -0
  43. package/dist/esm/registered-menu/RegisteredMenuList.js +215 -0
  44. package/dist/esm/registered-menu/RegisteredMenuListItemRow.js +54 -0
  45. package/dist/esm/registered-menu/RegisteredMenuSurfaceContext.js +6 -0
  46. package/dist/esm/registered-menu/getRegisteredMenuRows.js +4 -0
  47. package/dist/esm/registered-menu/types.js +1 -0
  48. package/dist/esm/{quick-insert/use-menu-list-height.js → registered-menu/useMenuListHeight.js} +15 -11
  49. package/dist/esm/{quick-insert/use-menu-popup-sizing.js → registered-menu/useMenuPopupSizing.js} +5 -1
  50. package/dist/esm/registered-menu/useRegisteredMenu.js +126 -0
  51. package/dist/esm/registered-menu/useRegisteredMenuSelection.js +46 -0
  52. package/dist/esm/ui/DropList/index.js +1 -1
  53. package/dist/types/insert/index.d.ts +5 -1
  54. package/dist/types/quick-insert/QuickInsertContext.d.ts +6 -5
  55. package/dist/types/quick-insert/QuickInsertMenuItem.d.ts +2 -2
  56. package/dist/types/quick-insert/quick-insert-rank.d.ts +1 -1
  57. package/dist/types/registered-menu/ActiveMenuItemKeyContext.d.ts +2 -0
  58. package/dist/types/registered-menu/MeasuredRow.d.ts +10 -0
  59. package/dist/types/registered-menu/RegisteredMenuContext.d.ts +4 -0
  60. package/dist/types/registered-menu/RegisteredMenuList.d.ts +31 -0
  61. package/dist/types/registered-menu/RegisteredMenuListItemRow.d.ts +28 -0
  62. package/dist/types/registered-menu/RegisteredMenuSurfaceContext.d.ts +7 -0
  63. package/dist/types/registered-menu/getRegisteredMenuRows.d.ts +4 -0
  64. package/dist/types/registered-menu/types.d.ts +55 -0
  65. package/dist/types/{quick-insert/use-menu-list-height.d.ts → registered-menu/useMenuListHeight.d.ts} +5 -1
  66. package/dist/types/{quick-insert/use-menu-popup-sizing.d.ts → registered-menu/useMenuPopupSizing.d.ts} +5 -1
  67. package/dist/types/registered-menu/useRegisteredMenu.d.ts +28 -0
  68. package/dist/types/registered-menu/useRegisteredMenuSelection.d.ts +16 -0
  69. package/dist/types/type-ahead/index.d.ts +0 -1
  70. package/dist/types/types/index.d.ts +1 -1
  71. package/dist/types/types/quick-insert.d.ts +1 -1
  72. package/dist/types/types/type-ahead.d.ts +9 -6
  73. package/package.json +9 -9
  74. package/registered-menu/context/package.json +10 -0
  75. package/registered-menu/item-rank/package.json +10 -0
  76. package/registered-menu/list/package.json +10 -0
  77. package/registered-menu/list-height/package.json +10 -0
  78. package/registered-menu/package.json +10 -0
  79. package/registered-menu/popup-sizing/package.json +10 -0
  80. package/registered-menu/rows/package.json +10 -0
  81. package/registered-menu/surface-context/package.json +10 -0
  82. package/registered-menu/use-registered-menu/package.json +10 -0
  83. package/dist/cjs/quick-insert/QuickInsertEmptyState.compiled.css +0 -11
  84. package/dist/cjs/quick-insert/QuickInsertEmptyState.js +0 -61
  85. package/dist/cjs/quick-insert/QuickInsertMenuRoot.js +0 -13
  86. package/dist/cjs/quick-insert/QuickInsertMenuSection.js +0 -23
  87. package/dist/cjs/quick-insert/QuickInsertSearchResultsSection.js +0 -19
  88. package/dist/cjs/quick-insert/assets/no-results.js +0 -36
  89. package/dist/cjs/quick-insert/get-quick-insert-menu-model.js +0 -234
  90. package/dist/cjs/quick-insert/getQuickInsertMenuRows.js +0 -12
  91. package/dist/cjs/quick-insert/registered-menu-model.js +0 -33
  92. package/dist/cjs/quick-insert/selectQuickInsertCategoryItems.js +0 -27
  93. package/dist/cjs/quick-insert/useQuickInsertSearchAnalytics.js +0 -100
  94. package/dist/cjs/type-ahead/TypeAheadSurfaceContext.js +0 -11
  95. package/dist/es2019/quick-insert/QuickInsertEmptyState.compiled.css +0 -11
  96. package/dist/es2019/quick-insert/QuickInsertEmptyState.js +0 -47
  97. package/dist/es2019/quick-insert/QuickInsertMenuRoot.js +0 -5
  98. package/dist/es2019/quick-insert/QuickInsertMenuSection.js +0 -15
  99. package/dist/es2019/quick-insert/QuickInsertSearchResultsSection.js +0 -14
  100. package/dist/es2019/quick-insert/assets/no-results.js +0 -30
  101. package/dist/es2019/quick-insert/get-quick-insert-menu-model.js +0 -174
  102. package/dist/es2019/quick-insert/getQuickInsertMenuRows.js +0 -4
  103. package/dist/es2019/quick-insert/registered-menu-model.js +0 -6
  104. package/dist/es2019/quick-insert/selectQuickInsertCategoryItems.js +0 -19
  105. package/dist/es2019/quick-insert/useQuickInsertSearchAnalytics.js +0 -91
  106. package/dist/es2019/type-ahead/TypeAheadSurfaceContext.js +0 -5
  107. package/dist/esm/quick-insert/QuickInsertEmptyState.compiled.css +0 -11
  108. package/dist/esm/quick-insert/QuickInsertEmptyState.js +0 -50
  109. package/dist/esm/quick-insert/QuickInsertMenuRoot.js +0 -6
  110. package/dist/esm/quick-insert/QuickInsertMenuSection.js +0 -16
  111. package/dist/esm/quick-insert/QuickInsertSearchResultsSection.js +0 -12
  112. package/dist/esm/quick-insert/assets/no-results.js +0 -29
  113. package/dist/esm/quick-insert/get-quick-insert-menu-model.js +0 -227
  114. package/dist/esm/quick-insert/getQuickInsertMenuRows.js +0 -5
  115. package/dist/esm/quick-insert/registered-menu-model.js +0 -6
  116. package/dist/esm/quick-insert/selectQuickInsertCategoryItems.js +0 -21
  117. package/dist/esm/quick-insert/useQuickInsertSearchAnalytics.js +0 -93
  118. package/dist/esm/type-ahead/TypeAheadSurfaceContext.js +0 -5
  119. package/dist/types/quick-insert/QuickInsertEmptyState.d.ts +0 -7
  120. package/dist/types/quick-insert/QuickInsertMenuRoot.d.ts +0 -2
  121. package/dist/types/quick-insert/QuickInsertMenuSection.d.ts +0 -4
  122. package/dist/types/quick-insert/QuickInsertSearchResultsSection.d.ts +0 -2
  123. package/dist/types/quick-insert/assets/no-results.d.ts +0 -7
  124. package/dist/types/quick-insert/get-quick-insert-menu-model.d.ts +0 -29
  125. package/dist/types/quick-insert/getQuickInsertMenuRows.d.ts +0 -3
  126. package/dist/types/quick-insert/registered-menu-model.d.ts +0 -6
  127. package/dist/types/quick-insert/selectQuickInsertCategoryItems.d.ts +0 -7
  128. package/dist/types/quick-insert/useQuickInsertSearchAnalytics.d.ts +0 -12
  129. package/dist/types/type-ahead/TypeAheadSurfaceContext.d.ts +0 -8
  130. package/quick-insert/empty-state/package.json +0 -10
  131. package/quick-insert/menu-root/package.json +0 -10
  132. package/quick-insert/menu-section/package.json +0 -10
  133. package/quick-insert/registered-menu-model/package.json +0 -10
  134. package/quick-insert/use-menu-list-height/package.json +0 -10
  135. package/quick-insert/use-menu-popup-sizing/package.json +0 -10
  136. package/quick-insert/use-search-analytics/package.json +0 -10
  137. package/type-ahead/item-rank/package.json +0 -10
  138. package/type-ahead-surface-context/package.json +0 -10
  139. /package/dist/cjs/{type-ahead → registered-menu}/item-rank.js +0 -0
  140. /package/dist/es2019/{type-ahead → registered-menu}/item-rank.js +0 -0
  141. /package/dist/esm/{type-ahead → registered-menu}/item-rank.js +0 -0
  142. /package/dist/types/{type-ahead → registered-menu}/item-rank.d.ts +0 -0
@@ -0,0 +1,120 @@
1
+ import { useCallback, useLayoutEffect, useMemo, useState } from 'react';
2
+ import { getComponentIdentity } from '@atlaskit/editor-ui-control-model/surface-renderer';
3
+ import { getRegisteredMenuRows } from './getRegisteredMenuRows';
4
+ import { useRegisteredMenuSelection } from './useRegisteredMenuSelection';
5
+ /**
6
+ * Connects menu rows to keyboard selection and tracks which item is active through
7
+ * keyboard, pointer and focus events. Selection controls navigation; activation lets
8
+ * the caller show item-specific feedback, such as a preview. A changed reset key
9
+ * starts navigation again and clears the active item.
10
+ */
11
+ export const useRegisteredMenu = ({
12
+ model,
13
+ resetKey
14
+ }) => {
15
+ const {
16
+ rows,
17
+ selectableItems,
18
+ selectableItemIdentities
19
+ } = useMemo(() => {
20
+ const rows = getRegisteredMenuRows(model);
21
+ const selectableItems = [];
22
+ const selectableItemIdentities = [];
23
+ rows.forEach(row => {
24
+ if (row.type === 'menu-item') {
25
+ selectableItems.push(row);
26
+ selectableItemIdentities.push(getComponentIdentity(row));
27
+ }
28
+ });
29
+ // The footer participates in navigation but is rendered outside the scrolling rows.
30
+ if (model.footer) {
31
+ selectableItemIdentities.push(getComponentIdentity(model.footer));
32
+ }
33
+ return {
34
+ rows,
35
+ selectableItems,
36
+ selectableItemIdentities
37
+ };
38
+ }, [model]);
39
+ const selection = useRegisteredMenuSelection({
40
+ identities: selectableItemIdentities,
41
+ resetKey
42
+ });
43
+ const {
44
+ selectedIndex: selectedItemIndex,
45
+ select
46
+ } = selection;
47
+ const [activation, setItemActivation] = useState();
48
+ const activeItemKey = (activation === null || activation === void 0 ? void 0 : activation.model) === model && activation.resetKey === resetKey ? activation.itemKey : undefined;
49
+ useLayoutEffect(() => {
50
+ setItemActivation(undefined);
51
+ }, [model, resetKey]);
52
+ const activateKeyboardItem = useCallback(index => {
53
+ const item = selectableItems[index];
54
+ setItemActivation(item ? {
55
+ itemKey: item.key,
56
+ model,
57
+ resetKey,
58
+ source: 'keyboard'
59
+ } : undefined);
60
+ }, [model, resetKey, selectableItems]);
61
+ const selectNext = useCallback(() => {
62
+ activateKeyboardItem(selection.selectNext());
63
+ }, [selection.selectNext, activateKeyboardItem]);
64
+ const selectPrevious = useCallback(() => {
65
+ activateKeyboardItem(selection.selectPrevious());
66
+ }, [selection.selectPrevious, activateKeyboardItem]);
67
+ const onItemHover = useCallback((index, itemKey) => {
68
+ select(index);
69
+ setItemActivation(current => {
70
+ if (itemKey && (current === null || current === void 0 ? void 0 : current.itemKey) === itemKey && current.model === model && current.resetKey === resetKey && current.source === 'pointer') {
71
+ return current;
72
+ }
73
+ return itemKey ? {
74
+ itemKey,
75
+ model,
76
+ resetKey,
77
+ source: 'pointer'
78
+ } : undefined;
79
+ });
80
+ }, [model, resetKey, select]);
81
+ const onItemFocus = useCallback((index, itemKey) => {
82
+ select(index);
83
+ setItemActivation(current => {
84
+ if (itemKey && (current === null || current === void 0 ? void 0 : current.itemKey) === itemKey && current.model === model && current.resetKey === resetKey) {
85
+ return current;
86
+ }
87
+ return itemKey ? {
88
+ itemKey,
89
+ model,
90
+ resetKey,
91
+ source: 'keyboard'
92
+ } : undefined;
93
+ });
94
+ }, [model, resetKey, select]);
95
+ const onItemLeave = useCallback(itemKey => {
96
+ setItemActivation(current => (current === null || current === void 0 ? void 0 : current.source) === 'pointer' && current.itemKey === itemKey ? undefined : current);
97
+ }, []);
98
+ const onItemBlur = useCallback(itemKey => {
99
+ setItemActivation(current => (current === null || current === void 0 ? void 0 : current.itemKey) === itemKey ? undefined : current);
100
+ }, []);
101
+ const onItemVisibilityChange = useCallback((itemKey, isVisible) => {
102
+ if (!isVisible) {
103
+ setItemActivation(current => (current === null || current === void 0 ? void 0 : current.source) === 'pointer' && current.itemKey === itemKey ? undefined : current);
104
+ }
105
+ }, []);
106
+ return {
107
+ rows,
108
+ selectableItems,
109
+ selectedItemIndex,
110
+ select,
111
+ selectNext,
112
+ selectPrevious,
113
+ activeItemKey,
114
+ onItemHover,
115
+ onItemFocus,
116
+ onItemLeave,
117
+ onItemBlur,
118
+ onItemVisibilityChange
119
+ };
120
+ };
@@ -0,0 +1,39 @@
1
+ import { useCallback, useLayoutEffect, useMemo, useRef, useState } from 'react';
2
+ /**
3
+ * Resets keyboard selection when the ordered items or reset key changes.
4
+ * The caller chooses the key, for example a search term or the current category.
5
+ */
6
+ export const useRegisteredMenuSelection = ({
7
+ identities,
8
+ resetKey
9
+ }) => {
10
+ const [selectedIndex, setSelectedIndex] = useState(() => identities.length > 0 ? 0 : -1);
11
+ const selectedIndexRef = useRef(selectedIndex);
12
+ const identitySignature = useMemo(() => JSON.stringify(identities), [identities]);
13
+ const itemCount = identities.length;
14
+ const select = useCallback(index => {
15
+ selectedIndexRef.current = index;
16
+ setSelectedIndex(index);
17
+ }, []);
18
+ useLayoutEffect(() => {
19
+ select(itemCount > 0 ? 0 : -1);
20
+ }, [identitySignature, itemCount, resetKey, select]);
21
+ const selectNext = useCallback(() => {
22
+ const currentIndex = selectedIndexRef.current;
23
+ const nextIndex = itemCount === 0 ? -1 : currentIndex < 0 ? 0 : (currentIndex + 1) % itemCount;
24
+ select(nextIndex);
25
+ return nextIndex;
26
+ }, [itemCount, select]);
27
+ const selectPrevious = useCallback(() => {
28
+ const currentIndex = selectedIndexRef.current;
29
+ const previousIndex = itemCount === 0 ? -1 : currentIndex <= 0 ? itemCount - 1 : currentIndex - 1;
30
+ select(previousIndex);
31
+ return previousIndex;
32
+ }, [itemCount, select]);
33
+ return {
34
+ selectedIndex,
35
+ select,
36
+ selectNext,
37
+ selectPrevious
38
+ };
39
+ };
@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
13
13
  import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
14
14
  import Layer from '../Layer';
15
15
  const packageName = "@atlaskit/editor-common";
16
- const packageVersion = "133.7.1";
16
+ const packageVersion = "133.7.2";
17
17
  const halfFocusRing = 1;
18
18
  const dropOffset = '0, 8';
19
19
  // Ignored via go/ees005
@@ -7,6 +7,9 @@ import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/tra
7
7
  import { canInsert, findParentNodeOfType, hasParentNodeOfType, isNodeSelection, safeInsert as pmSafeInsert } from '@atlaskit/editor-prosemirror/utils';
8
8
  import { GapCursorSelection, Side } from '../selection';
9
9
  import { isEmptyParagraph, isListItemNode } from '../utils';
10
+
11
+ /** Builds an insertion transaction using the editor state and position supplied by the host. */
12
+
10
13
  export var LookDirection = /*#__PURE__*/function (LookDirection) {
11
14
  LookDirection["Before"] = "before";
12
15
  LookDirection["After"] = "after";
@@ -19,7 +19,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
19
19
  var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
20
20
  var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
21
21
  var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
22
- var packageVersion = "133.7.1";
22
+ var packageVersion = "133.7.2";
23
23
  var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
24
24
  // Remove URL as it has UGC
25
25
  // Ignored via go/ees007
@@ -1,2 +1,6 @@
1
1
  import { createContext } from 'react';
2
+ /**
3
+ * Gives Quick Insert items access to the editor and the function for selecting a command.
4
+ * The menu supplies shared values; each item adds its selected and preview state.
5
+ */
2
6
  export var QuickInsertContext = /*#__PURE__*/createContext(null);
@@ -1,8 +1,10 @@
1
1
  import React from 'react';
2
+ import { REGISTERED_MENU_SURFACE_CONTEXT } from '../registered-menu/RegisteredMenuSurfaceContext';
2
3
  import { CompactQuickInsertMenuItem } from './CompactQuickInsertMenuItem';
3
4
  import { ElementBrowserQuickInsertMenuItem } from './ElementBrowserQuickInsertMenuItem';
4
5
  import { useQuickInsertContext } from './useQuickInsertContext';
5
6
  export var QuickInsertMenuItem = function QuickInsertMenuItem(_ref) {
7
+ var _surfaceContext$get;
6
8
  var ariaLabel = _ref.ariaLabel,
7
9
  description = _ref.description,
8
10
  iconBefore = _ref.iconBefore,
@@ -19,7 +21,8 @@ export var QuickInsertMenuItem = function QuickInsertMenuItem(_ref) {
19
21
  shouldWrapIcon = _ref.shouldWrapIcon,
20
22
  title = _ref.title;
21
23
  var _useQuickInsertContex = useQuickInsertContext(),
22
- surface = _useQuickInsertContex.surface;
24
+ surfaceContext = _useQuickInsertContex.surfaceContext;
25
+ var surface = surfaceContext === null || surfaceContext === void 0 || (_surfaceContext$get = surfaceContext.get(REGISTERED_MENU_SURFACE_CONTEXT)) === null || _surfaceContext$get === void 0 ? void 0 : _surfaceContext$get.surface;
23
26
  return surface === 'element-browser' ? /*#__PURE__*/React.createElement(ElementBrowserQuickInsertMenuItem, {
24
27
  ariaLabel: ariaLabel,
25
28
  description: description,
@@ -0,0 +1,5 @@
1
+ import { createContext } from 'react';
2
+ // The list caches rendered rows while scrolling, so those rows may not receive
3
+ // updated props. We pass the active item key down through context so their styling
4
+ // updates without rebuilding the wrappers that measure row height.
5
+ export var ActiveMenuItemKeyContext = /*#__PURE__*/createContext(undefined);
@@ -0,0 +1,33 @@
1
+ import React, { useEffect, useRef } from 'react';
2
+ import { Box } from '@atlaskit/primitives/compiled/box';
3
+ export var MeasuredRow = function MeasuredRow(_ref) {
4
+ var children = _ref.children,
5
+ isScrolling = _ref.isScrolling,
6
+ isVisible = _ref.isVisible,
7
+ measure = _ref.measure,
8
+ onMeasured = _ref.onMeasured,
9
+ paddingBlockStart = _ref.paddingBlockStart,
10
+ paddingBlockEnd = _ref.paddingBlockEnd;
11
+ var rowRef = useRef(null);
12
+ useEffect(function () {
13
+ var row = rowRef.current;
14
+ if (!row || isScrolling || !isVisible || typeof ResizeObserver === 'undefined') {
15
+ return;
16
+ }
17
+ var observer = new ResizeObserver(function () {
18
+ measure();
19
+ onMeasured();
20
+ });
21
+ observer.observe(row, {
22
+ box: 'border-box'
23
+ });
24
+ return function () {
25
+ return observer.disconnect();
26
+ };
27
+ }, [isScrolling, isVisible, measure, onMeasured]);
28
+ return /*#__PURE__*/React.createElement(Box, {
29
+ ref: rowRef,
30
+ paddingBlockStart: paddingBlockStart,
31
+ paddingBlockEnd: paddingBlockEnd
32
+ }, children);
33
+ };
@@ -0,0 +1,9 @@
1
+ import { createContext, useContext } from 'react';
2
+ export var RegisteredMenuContext = /*#__PURE__*/createContext(null);
3
+ export var useRegisteredMenuContext = function useRegisteredMenuContext() {
4
+ var context = useContext(RegisteredMenuContext);
5
+ if (!context) {
6
+ throw new Error('useRegisteredMenuContext must be used within RegisteredMenuContext.Provider');
7
+ }
8
+ return context;
9
+ };
@@ -0,0 +1,215 @@
1
+ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
2
+ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
3
+ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
4
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
5
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
6
+ import React, { useCallback, useLayoutEffect, useMemo, useRef } from 'react';
7
+ import { CellMeasurer, CellMeasurerCache } from 'react-virtualized/dist/commonjs/CellMeasurer';
8
+ import { List } from 'react-virtualized/dist/commonjs/List';
9
+ import { ActiveMenuItemKeyContext } from './ActiveMenuItemKeyContext';
10
+ import { MeasuredRow } from './MeasuredRow';
11
+ import { RegisteredMenuListItemRow } from './RegisteredMenuListItemRow';
12
+ import { useMenuListHeight } from './useMenuListHeight';
13
+ var ESTIMATED_ROW_HEIGHT = 44;
14
+ export var RegisteredMenuList = function RegisteredMenuList(_ref) {
15
+ var rows = _ref.rows,
16
+ Item = _ref.Item,
17
+ selectedItemIndex = _ref.selectedItemIndex,
18
+ activeItemKey = _ref.activeItemKey,
19
+ maxHeight = _ref.maxHeight,
20
+ width = _ref.width,
21
+ getItemId = _ref.getItemId,
22
+ onItemHover = _ref.onItemHover,
23
+ onItemFocus = _ref.onItemFocus,
24
+ onItemLeave = _ref.onItemLeave,
25
+ onItemBlur = _ref.onItemBlur,
26
+ onItemVisibilityChange = _ref.onItemVisibilityChange,
27
+ onRenderedItemsChange = _ref.onRenderedItemsChange,
28
+ scrollResetKey = _ref.scrollResetKey,
29
+ _ref$role = _ref.role,
30
+ role = _ref$role === void 0 ? 'presentation' : _ref$role,
31
+ _ref$containerRole = _ref.containerRole,
32
+ containerRole = _ref$containerRole === void 0 ? 'presentation' : _ref$containerRole,
33
+ tabIndex = _ref.tabIndex,
34
+ _ref$omitAriaReadonly = _ref.omitAriaReadonly,
35
+ omitAriaReadonly = _ref$omitAriaReadonly === void 0 ? false : _ref$omitAriaReadonly,
36
+ _ref$hasScrollPadding = _ref.hasScrollPadding,
37
+ hasScrollPadding = _ref$hasScrollPadding === void 0 ? false : _ref$hasScrollPadding,
38
+ _ref$lastRowPadding = _ref.lastRowPadding,
39
+ lastRowPadding = _ref$lastRowPadding === void 0 ? 'none' : _ref$lastRowPadding,
40
+ _ref$scrollTo = _ref.scrollTo,
41
+ scrollTo = _ref$scrollTo === void 0 ? 'selected' : _ref$scrollTo;
42
+ var listRef = useRef(null);
43
+ var cache = useMemo(function () {
44
+ return new CellMeasurerCache({
45
+ defaultHeight: ESTIMATED_ROW_HEIGHT,
46
+ fixedWidth: true
47
+ });
48
+ }, []);
49
+ var itemIndexByRowIndex = useMemo(function () {
50
+ var indexes = new Map();
51
+ var itemIndex = 0;
52
+ rows.forEach(function (row, rowIndex) {
53
+ if (row.type === 'menu-item') {
54
+ indexes.set(rowIndex, itemIndex++);
55
+ }
56
+ });
57
+ return indexes;
58
+ }, [rows]);
59
+ var selectedRowIndex = useMemo(function () {
60
+ var _iterator = _createForOfIteratorHelper(itemIndexByRowIndex),
61
+ _step;
62
+ try {
63
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
64
+ var _step$value = _slicedToArray(_step.value, 2),
65
+ rowIndex = _step$value[0],
66
+ itemIndex = _step$value[1];
67
+ if (itemIndex === selectedItemIndex) {
68
+ return rowIndex;
69
+ }
70
+ }
71
+ } catch (err) {
72
+ _iterator.e(err);
73
+ } finally {
74
+ _iterator.f();
75
+ }
76
+ return -1;
77
+ }, [itemIndexByRowIndex, selectedItemIndex]);
78
+ var rowKeySignature = useMemo(function () {
79
+ return rows.map(function (_ref2) {
80
+ var key = _ref2.key,
81
+ type = _ref2.type;
82
+ return "".concat(type, ":").concat(key);
83
+ }).join('\0');
84
+ }, [rows]);
85
+ var _useMenuListHeight = useMenuListHeight(cache, rows.length, rowKeySignature),
86
+ measuredHeight = _useMenuListHeight.height,
87
+ updateHeight = _useMenuListHeight.updateHeight;
88
+ // react-virtualized forwards null to omit its grid-only default value.
89
+ var ariaReadonly = omitAriaReadonly ? null : undefined;
90
+ useLayoutEffect(function () {
91
+ var _listRef$current;
92
+ cache.clearAll();
93
+ (_listRef$current = listRef.current) === null || _listRef$current === void 0 || _listRef$current.recomputeRowHeights();
94
+ }, [cache, rowKeySignature]);
95
+ var previousResetKeyRef = useRef(scrollResetKey);
96
+ useLayoutEffect(function () {
97
+ if (scrollTo === 'top-on-reset' && previousResetKeyRef.current !== scrollResetKey) {
98
+ var _listRef$current2;
99
+ previousResetKeyRef.current = scrollResetKey;
100
+ (_listRef$current2 = listRef.current) === null || _listRef$current2 === void 0 || _listRef$current2.scrollToPosition(0);
101
+ return;
102
+ }
103
+ previousResetKeyRef.current = scrollResetKey;
104
+ if (selectedRowIndex >= 0) {
105
+ var _listRef$current3;
106
+ (_listRef$current3 = listRef.current) === null || _listRef$current3 === void 0 || _listRef$current3.scrollToRow(selectedRowIndex);
107
+ }
108
+ }, [scrollResetKey, rowKeySignature, scrollTo, selectedRowIndex]);
109
+ var handleRowsRendered = useCallback(function (_ref3) {
110
+ var _indexes$, _indexes;
111
+ var overscanStartIndex = _ref3.overscanStartIndex,
112
+ overscanStopIndex = _ref3.overscanStopIndex,
113
+ startIndex = _ref3.startIndex,
114
+ stopIndex = _ref3.stopIndex;
115
+ if (activeItemKey) {
116
+ var activeRowIndex = rows.findIndex(function (row) {
117
+ return row.type === 'menu-item' && row.key === activeItemKey;
118
+ });
119
+ if (activeRowIndex >= 0 && (activeRowIndex < startIndex || activeRowIndex > stopIndex)) {
120
+ onItemVisibilityChange(activeItemKey, false);
121
+ }
122
+ }
123
+ updateHeight();
124
+ var indexes = _toConsumableArray(itemIndexByRowIndex).filter(function (_ref4) {
125
+ var _ref5 = _slicedToArray(_ref4, 1),
126
+ rowIndex = _ref5[0];
127
+ return rowIndex >= overscanStartIndex && rowIndex <= overscanStopIndex;
128
+ }).map(function (_ref6) {
129
+ var _ref7 = _slicedToArray(_ref6, 2),
130
+ itemIndex = _ref7[1];
131
+ return itemIndex;
132
+ });
133
+ onRenderedItemsChange === null || onRenderedItemsChange === void 0 || onRenderedItemsChange({
134
+ startIndex: (_indexes$ = indexes[0]) !== null && _indexes$ !== void 0 ? _indexes$ : -1,
135
+ stopIndex: (_indexes = indexes[indexes.length - 1]) !== null && _indexes !== void 0 ? _indexes : -1
136
+ });
137
+ }, [activeItemKey, itemIndexByRowIndex, onItemVisibilityChange, onRenderedItemsChange, rows, updateHeight]);
138
+ var renderRow = useCallback(function (_ref8) {
139
+ var index = _ref8.index,
140
+ key = _ref8.key,
141
+ parent = _ref8.parent,
142
+ style = _ref8.style,
143
+ _ref8$isScrolling = _ref8.isScrolling,
144
+ isScrolling = _ref8$isScrolling === void 0 ? false : _ref8$isScrolling,
145
+ _ref8$isVisible = _ref8.isVisible,
146
+ isVisible = _ref8$isVisible === void 0 ? true : _ref8$isVisible;
147
+ var registration = rows[index];
148
+ if (!registration) {
149
+ return null;
150
+ }
151
+ var itemIndex = itemIndexByRowIndex.get(index);
152
+ var RegisteredComponent = registration.component;
153
+ var paddingBlockStart = hasScrollPadding && index === 0 ? 'space.100' : undefined;
154
+ var paddingBlockEnd = (hasScrollPadding || lastRowPadding === 'space.100') && index === rows.length - 1 ? 'space.100' : undefined;
155
+ return /*#__PURE__*/React.createElement(CellMeasurer, {
156
+ key: key,
157
+ cache: cache,
158
+ parent: parent,
159
+ columnIndex: 0,
160
+ rowIndex: index
161
+ }, function (_ref9) {
162
+ var registerChild = _ref9.registerChild,
163
+ measure = _ref9.measure;
164
+ return /*#__PURE__*/React.createElement("div", {
165
+ ref: function ref(element) {
166
+ return registerChild === null || registerChild === void 0 ? void 0 : registerChild(element !== null && element !== void 0 ? element : undefined);
167
+ }
168
+ // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- react-virtualized provides row offsets at runtime.
169
+ ,
170
+ style: style
171
+ }, /*#__PURE__*/React.createElement(MeasuredRow, {
172
+ paddingBlockStart: paddingBlockStart,
173
+ paddingBlockEnd: paddingBlockEnd,
174
+ isScrolling: isScrolling,
175
+ isVisible: isVisible,
176
+ measure: measure,
177
+ onMeasured: updateHeight
178
+ }, registration.type === 'menu-section' ? RegisteredComponent ? /*#__PURE__*/React.createElement(RegisteredComponent, null) : null : /*#__PURE__*/React.createElement(RegisteredMenuListItemRow, {
179
+ Item: Item,
180
+ getItemId: getItemId,
181
+ itemIndex: itemIndex !== null && itemIndex !== void 0 ? itemIndex : 0,
182
+ isVisible: isVisible,
183
+ onItemBlur: onItemBlur,
184
+ onItemFocus: onItemFocus,
185
+ onItemHover: onItemHover,
186
+ onItemLeave: onItemLeave,
187
+ onItemVisibilityChange: onItemVisibilityChange,
188
+ registration: registration,
189
+ rowIndex: index,
190
+ selectedItemIndex: selectedItemIndex
191
+ })));
192
+ });
193
+ }, [Item, cache, getItemId, hasScrollPadding, itemIndexByRowIndex, lastRowPadding, onItemBlur, onItemFocus, onItemHover, onItemLeave, onItemVisibilityChange, rows, selectedItemIndex, updateHeight]);
194
+ if (rows.length === 0) {
195
+ return null;
196
+ }
197
+ return /*#__PURE__*/React.createElement(ActiveMenuItemKeyContext.Provider, {
198
+ value: activeItemKey
199
+ }, /*#__PURE__*/React.createElement(List, {
200
+ "aria-readonly": ariaReadonly,
201
+ containerRole: containerRole,
202
+ height: Math.min(measuredHeight, Math.max(0, maxHeight)),
203
+ ref: listRef,
204
+ onRowsRendered: handleRowsRendered,
205
+ overscanRowCount: 3,
206
+ role: role,
207
+ rowCount: rows.length,
208
+ rowHeight: cache.rowHeight,
209
+ rowRenderer: renderRow,
210
+ scrollToAlignment: "auto",
211
+ scrollToIndex: scrollTo === 'selected' ? selectedRowIndex : undefined,
212
+ tabIndex: tabIndex,
213
+ width: width
214
+ }));
215
+ };
@@ -0,0 +1,54 @@
1
+ import React, { useCallback, useContext, useLayoutEffect } from 'react';
2
+ import { ActiveMenuItemKeyContext } from './ActiveMenuItemKeyContext';
3
+ /**
4
+ * Connects a rendered item to the list's active state and interaction callbacks.
5
+ * The list may reuse this row while scrolling, so context keeps its active styling
6
+ * current. The wrapper handles events without requiring registered components to
7
+ * forward them, and keeps the item active when focus moves between its children.
8
+ */
9
+ export var RegisteredMenuListItemRow = function RegisteredMenuListItemRow(_ref) {
10
+ var Item = _ref.Item,
11
+ getItemId = _ref.getItemId,
12
+ itemIndex = _ref.itemIndex,
13
+ isVisible = _ref.isVisible,
14
+ onItemBlur = _ref.onItemBlur,
15
+ onItemFocus = _ref.onItemFocus,
16
+ onItemHover = _ref.onItemHover,
17
+ onItemLeave = _ref.onItemLeave,
18
+ onItemVisibilityChange = _ref.onItemVisibilityChange,
19
+ registration = _ref.registration,
20
+ rowIndex = _ref.rowIndex,
21
+ selectedItemIndex = _ref.selectedItemIndex;
22
+ var activeItemKey = useContext(ActiveMenuItemKeyContext);
23
+ useLayoutEffect(function () {
24
+ onItemVisibilityChange(registration.key, isVisible);
25
+ return function () {
26
+ return onItemVisibilityChange(registration.key, false);
27
+ };
28
+ }, [isVisible, onItemVisibilityChange, registration.key]);
29
+ var onBlur = useCallback(function (event) {
30
+ if (!event.currentTarget.contains(event.relatedTarget)) {
31
+ onItemBlur(registration.key);
32
+ }
33
+ }, [onItemBlur, registration.key]);
34
+ return /*#__PURE__*/React.createElement("div", {
35
+ onBlur: onBlur,
36
+ onFocus: function onFocus() {
37
+ return onItemFocus(itemIndex, registration.key);
38
+ },
39
+ onMouseLeave: function onMouseLeave() {
40
+ return onItemLeave(registration.key);
41
+ },
42
+ onMouseMove: function onMouseMove() {
43
+ return onItemHover(itemIndex, registration.key);
44
+ }
45
+ }, /*#__PURE__*/React.createElement(Item, {
46
+ id: getItemId({
47
+ itemIndex: itemIndex,
48
+ rowIndex: rowIndex
49
+ }),
50
+ isActive: activeItemKey === registration.key,
51
+ isSelected: itemIndex === selectedItemIndex,
52
+ registration: registration
53
+ }));
54
+ };
@@ -0,0 +1,6 @@
1
+ import { createSurfaceContext } from '@atlaskit/editor-ui-control-model/create-surface-context';
2
+ import { createContextToken } from '@atlaskit/editor-ui-control-model/types';
3
+ export var REGISTERED_MENU_SURFACE_CONTEXT = createContextToken('registered-menu-surface-context');
4
+ export var createRegisteredMenuSurfaceContext = function createRegisteredMenuSurfaceContext(value) {
5
+ return createSurfaceContext(REGISTERED_MENU_SURFACE_CONTEXT, value);
6
+ };
@@ -0,0 +1,4 @@
1
+ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
2
+ export var getRegisteredMenuRows = function getRegisteredMenuRows(model) {
3
+ return [].concat(_toConsumableArray(model.sections.flat()), _toConsumableArray(model.fallbackItems));
4
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -1,6 +1,10 @@
1
1
  import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
2
2
  import { useCallback, useLayoutEffect, useRef, useState } from 'react';
3
- /** Keep the list viewport in sync with measured rows, including short search results. */
3
+ /**
4
+ * Fits the scrolling viewport to the total row height, so short menus do not leave
5
+ * empty space below their items. Rows can change height after rendering. Height
6
+ * updates wait for the next frame so all row measurements are included.
7
+ */
4
8
  export function useMenuListHeight(cache, rowCount, rowKeySignature) {
5
9
  var _useState = useState(function () {
6
10
  return Array.from({
@@ -17,10 +21,14 @@ export function useMenuListHeight(cache, rowCount, rowKeySignature) {
17
21
  height = _useState2[0],
18
22
  setHeight = _useState2[1];
19
23
  var frame = useRef();
20
- var updateHeight = useCallback(function () {
24
+ var cancelFrame = useCallback(function () {
21
25
  if (frame.current !== undefined) {
22
26
  cancelAnimationFrame(frame.current);
27
+ frame.current = undefined;
23
28
  }
29
+ }, []);
30
+ var updateHeight = useCallback(function () {
31
+ cancelFrame();
24
32
  // CellMeasurer updates its cache during commit. Read it after all rows have measured.
25
33
  frame.current = requestAnimationFrame(function () {
26
34
  frame.current = undefined;
@@ -30,20 +38,16 @@ export function useMenuListHeight(cache, rowCount, rowKeySignature) {
30
38
  return cache.rowHeight({
31
39
  index: index
32
40
  });
33
- }).reduce(function (sum, height) {
34
- return sum + height;
41
+ }).reduce(function (sum, value) {
42
+ return sum + value;
35
43
  }, 0);
36
44
  setHeight(total);
37
45
  });
38
- }, [cache, rowCount]);
46
+ }, [cache, cancelFrame, rowCount]);
39
47
  useLayoutEffect(function () {
40
48
  updateHeight();
41
- return function () {
42
- if (frame.current !== undefined) {
43
- cancelAnimationFrame(frame.current);
44
- }
45
- };
46
- }, [rowKeySignature, updateHeight]);
49
+ return cancelFrame;
50
+ }, [cancelFrame, rowKeySignature, updateHeight]);
47
51
  return {
48
52
  height: height,
49
53
  updateHeight: updateHeight
@@ -3,7 +3,11 @@ import { useLayoutEffect, useState } from 'react';
3
3
  import { bind } from 'bind-event-listener';
4
4
  import rafSchedule from 'raf-schd';
5
5
  import { findOverflowScrollParent } from '../ui/Popup/utils';
6
- /** Constrain menu height to the available space; Popup chooses placement. */
6
+ /**
7
+ * Limits menu height to the space around its anchor as the page scrolls or resizes.
8
+ * It allows room above or below the anchor because Popup can choose either side.
9
+ * This hook controls height only; Popup still positions the menu.
10
+ */
7
11
  export function useMenuPopupSizing(_ref) {
8
12
  var target = _ref.target,
9
13
  boundariesElement = _ref.boundariesElement,