@atlaskit/editor-common 133.7.2 → 134.0.1

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 (163) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/cjs/insert/index.js +1 -0
  3. package/dist/cjs/lists/messages.js +3 -3
  4. package/dist/cjs/messages/block-type.js +9 -9
  5. package/dist/cjs/messages/card.js +4 -4
  6. package/dist/cjs/messages/insert-block.js +8 -8
  7. package/dist/cjs/messages/layout.js +5 -5
  8. package/dist/cjs/messages/list.js +3 -3
  9. package/dist/cjs/messages/snippets.js +1 -1
  10. package/dist/cjs/monitoring/error.js +1 -1
  11. package/dist/cjs/quick-insert/QuickInsertContext.js +4 -0
  12. package/dist/cjs/quick-insert/QuickInsertMenuItem.js +4 -1
  13. package/dist/cjs/registered-menu/ActiveMenuItemKeyContext.js +11 -0
  14. package/dist/cjs/registered-menu/MeasuredRow.js +41 -0
  15. package/dist/cjs/registered-menu/RegisteredMenuContext.js +15 -0
  16. package/dist/cjs/registered-menu/RegisteredMenuList.js +224 -0
  17. package/dist/cjs/registered-menu/RegisteredMenuListItemRow.js +62 -0
  18. package/dist/cjs/registered-menu/RegisteredMenuSurfaceContext.js +12 -0
  19. package/dist/cjs/registered-menu/getRegisteredMenuRows.js +11 -0
  20. package/dist/cjs/registered-menu/types.js +5 -0
  21. package/dist/cjs/{quick-insert/use-menu-list-height.js → registered-menu/useMenuListHeight.js} +15 -11
  22. package/dist/cjs/{quick-insert/use-menu-popup-sizing.js → registered-menu/useMenuPopupSizing.js} +5 -1
  23. package/dist/cjs/registered-menu/useRegisteredMenu.js +133 -0
  24. package/dist/cjs/registered-menu/useRegisteredMenuSelection.js +53 -0
  25. package/dist/cjs/ui/DropList/index.js +1 -1
  26. package/dist/es2019/insert/index.js +3 -0
  27. package/dist/es2019/lists/messages.js +3 -3
  28. package/dist/es2019/messages/block-type.js +9 -9
  29. package/dist/es2019/messages/card.js +4 -4
  30. package/dist/es2019/messages/insert-block.js +8 -8
  31. package/dist/es2019/messages/layout.js +5 -5
  32. package/dist/es2019/messages/list.js +3 -3
  33. package/dist/es2019/messages/snippets.js +1 -1
  34. package/dist/es2019/monitoring/error.js +1 -1
  35. package/dist/es2019/quick-insert/QuickInsertContext.js +4 -0
  36. package/dist/es2019/quick-insert/QuickInsertMenuItem.js +4 -1
  37. package/dist/es2019/registered-menu/ActiveMenuItemKeyContext.js +5 -0
  38. package/dist/es2019/registered-menu/MeasuredRow.js +32 -0
  39. package/dist/es2019/registered-menu/RegisteredMenuContext.js +9 -0
  40. package/dist/es2019/registered-menu/RegisteredMenuList.js +177 -0
  41. package/dist/es2019/registered-menu/RegisteredMenuListItemRow.js +47 -0
  42. package/dist/es2019/registered-menu/RegisteredMenuSurfaceContext.js +4 -0
  43. package/dist/es2019/registered-menu/getRegisteredMenuRows.js +1 -0
  44. package/dist/es2019/registered-menu/types.js +1 -0
  45. package/dist/es2019/{quick-insert/use-menu-list-height.js → registered-menu/useMenuListHeight.js} +14 -10
  46. package/dist/es2019/{quick-insert/use-menu-popup-sizing.js → registered-menu/useMenuPopupSizing.js} +5 -1
  47. package/dist/es2019/registered-menu/useRegisteredMenu.js +120 -0
  48. package/dist/es2019/registered-menu/useRegisteredMenuSelection.js +39 -0
  49. package/dist/es2019/ui/DropList/index.js +1 -1
  50. package/dist/esm/insert/index.js +3 -0
  51. package/dist/esm/lists/messages.js +3 -3
  52. package/dist/esm/messages/block-type.js +9 -9
  53. package/dist/esm/messages/card.js +4 -4
  54. package/dist/esm/messages/insert-block.js +8 -8
  55. package/dist/esm/messages/layout.js +5 -5
  56. package/dist/esm/messages/list.js +3 -3
  57. package/dist/esm/messages/snippets.js +1 -1
  58. package/dist/esm/monitoring/error.js +1 -1
  59. package/dist/esm/quick-insert/QuickInsertContext.js +4 -0
  60. package/dist/esm/quick-insert/QuickInsertMenuItem.js +4 -1
  61. package/dist/esm/registered-menu/ActiveMenuItemKeyContext.js +5 -0
  62. package/dist/esm/registered-menu/MeasuredRow.js +33 -0
  63. package/dist/esm/registered-menu/RegisteredMenuContext.js +9 -0
  64. package/dist/esm/registered-menu/RegisteredMenuList.js +215 -0
  65. package/dist/esm/registered-menu/RegisteredMenuListItemRow.js +54 -0
  66. package/dist/esm/registered-menu/RegisteredMenuSurfaceContext.js +6 -0
  67. package/dist/esm/registered-menu/getRegisteredMenuRows.js +4 -0
  68. package/dist/esm/registered-menu/types.js +1 -0
  69. package/dist/esm/{quick-insert/use-menu-list-height.js → registered-menu/useMenuListHeight.js} +15 -11
  70. package/dist/esm/{quick-insert/use-menu-popup-sizing.js → registered-menu/useMenuPopupSizing.js} +5 -1
  71. package/dist/esm/registered-menu/useRegisteredMenu.js +126 -0
  72. package/dist/esm/registered-menu/useRegisteredMenuSelection.js +46 -0
  73. package/dist/esm/ui/DropList/index.js +1 -1
  74. package/dist/types/insert/index.d.ts +5 -1
  75. package/dist/types/quick-insert/QuickInsertContext.d.ts +6 -5
  76. package/dist/types/quick-insert/QuickInsertMenuItem.d.ts +2 -2
  77. package/dist/types/quick-insert/quick-insert-rank.d.ts +1 -1
  78. package/dist/types/registered-menu/ActiveMenuItemKeyContext.d.ts +2 -0
  79. package/dist/types/registered-menu/MeasuredRow.d.ts +10 -0
  80. package/dist/types/registered-menu/RegisteredMenuContext.d.ts +4 -0
  81. package/dist/types/registered-menu/RegisteredMenuList.d.ts +31 -0
  82. package/dist/types/registered-menu/RegisteredMenuListItemRow.d.ts +28 -0
  83. package/dist/types/registered-menu/RegisteredMenuSurfaceContext.d.ts +7 -0
  84. package/dist/types/registered-menu/getRegisteredMenuRows.d.ts +4 -0
  85. package/dist/types/registered-menu/types.d.ts +55 -0
  86. package/dist/types/{quick-insert/use-menu-list-height.d.ts → registered-menu/useMenuListHeight.d.ts} +5 -1
  87. package/dist/types/{quick-insert/use-menu-popup-sizing.d.ts → registered-menu/useMenuPopupSizing.d.ts} +5 -1
  88. package/dist/types/registered-menu/useRegisteredMenu.d.ts +28 -0
  89. package/dist/types/registered-menu/useRegisteredMenuSelection.d.ts +16 -0
  90. package/dist/types/type-ahead/index.d.ts +0 -1
  91. package/dist/types/types/index.d.ts +1 -1
  92. package/dist/types/types/quick-insert.d.ts +1 -1
  93. package/dist/types/types/type-ahead.d.ts +9 -6
  94. package/package.json +9 -9
  95. package/registered-menu/context/package.json +10 -0
  96. package/registered-menu/item-rank/package.json +10 -0
  97. package/registered-menu/list/package.json +10 -0
  98. package/registered-menu/list-height/package.json +10 -0
  99. package/registered-menu/package.json +10 -0
  100. package/registered-menu/popup-sizing/package.json +10 -0
  101. package/registered-menu/rows/package.json +10 -0
  102. package/registered-menu/surface-context/package.json +10 -0
  103. package/registered-menu/use-registered-menu/package.json +10 -0
  104. package/dist/cjs/quick-insert/QuickInsertEmptyState.compiled.css +0 -11
  105. package/dist/cjs/quick-insert/QuickInsertEmptyState.js +0 -61
  106. package/dist/cjs/quick-insert/QuickInsertMenuRoot.js +0 -13
  107. package/dist/cjs/quick-insert/QuickInsertMenuSection.js +0 -23
  108. package/dist/cjs/quick-insert/QuickInsertSearchResultsSection.js +0 -19
  109. package/dist/cjs/quick-insert/assets/no-results.js +0 -36
  110. package/dist/cjs/quick-insert/get-quick-insert-menu-model.js +0 -234
  111. package/dist/cjs/quick-insert/getQuickInsertMenuRows.js +0 -12
  112. package/dist/cjs/quick-insert/registered-menu-model.js +0 -33
  113. package/dist/cjs/quick-insert/selectQuickInsertCategoryItems.js +0 -27
  114. package/dist/cjs/quick-insert/useQuickInsertSearchAnalytics.js +0 -100
  115. package/dist/cjs/type-ahead/TypeAheadSurfaceContext.js +0 -11
  116. package/dist/es2019/quick-insert/QuickInsertEmptyState.compiled.css +0 -11
  117. package/dist/es2019/quick-insert/QuickInsertEmptyState.js +0 -47
  118. package/dist/es2019/quick-insert/QuickInsertMenuRoot.js +0 -5
  119. package/dist/es2019/quick-insert/QuickInsertMenuSection.js +0 -15
  120. package/dist/es2019/quick-insert/QuickInsertSearchResultsSection.js +0 -14
  121. package/dist/es2019/quick-insert/assets/no-results.js +0 -30
  122. package/dist/es2019/quick-insert/get-quick-insert-menu-model.js +0 -174
  123. package/dist/es2019/quick-insert/getQuickInsertMenuRows.js +0 -4
  124. package/dist/es2019/quick-insert/registered-menu-model.js +0 -6
  125. package/dist/es2019/quick-insert/selectQuickInsertCategoryItems.js +0 -19
  126. package/dist/es2019/quick-insert/useQuickInsertSearchAnalytics.js +0 -91
  127. package/dist/es2019/type-ahead/TypeAheadSurfaceContext.js +0 -5
  128. package/dist/esm/quick-insert/QuickInsertEmptyState.compiled.css +0 -11
  129. package/dist/esm/quick-insert/QuickInsertEmptyState.js +0 -50
  130. package/dist/esm/quick-insert/QuickInsertMenuRoot.js +0 -6
  131. package/dist/esm/quick-insert/QuickInsertMenuSection.js +0 -16
  132. package/dist/esm/quick-insert/QuickInsertSearchResultsSection.js +0 -12
  133. package/dist/esm/quick-insert/assets/no-results.js +0 -29
  134. package/dist/esm/quick-insert/get-quick-insert-menu-model.js +0 -227
  135. package/dist/esm/quick-insert/getQuickInsertMenuRows.js +0 -5
  136. package/dist/esm/quick-insert/registered-menu-model.js +0 -6
  137. package/dist/esm/quick-insert/selectQuickInsertCategoryItems.js +0 -21
  138. package/dist/esm/quick-insert/useQuickInsertSearchAnalytics.js +0 -93
  139. package/dist/esm/type-ahead/TypeAheadSurfaceContext.js +0 -5
  140. package/dist/types/quick-insert/QuickInsertEmptyState.d.ts +0 -7
  141. package/dist/types/quick-insert/QuickInsertMenuRoot.d.ts +0 -2
  142. package/dist/types/quick-insert/QuickInsertMenuSection.d.ts +0 -4
  143. package/dist/types/quick-insert/QuickInsertSearchResultsSection.d.ts +0 -2
  144. package/dist/types/quick-insert/assets/no-results.d.ts +0 -7
  145. package/dist/types/quick-insert/get-quick-insert-menu-model.d.ts +0 -29
  146. package/dist/types/quick-insert/getQuickInsertMenuRows.d.ts +0 -3
  147. package/dist/types/quick-insert/registered-menu-model.d.ts +0 -6
  148. package/dist/types/quick-insert/selectQuickInsertCategoryItems.d.ts +0 -7
  149. package/dist/types/quick-insert/useQuickInsertSearchAnalytics.d.ts +0 -12
  150. package/dist/types/type-ahead/TypeAheadSurfaceContext.d.ts +0 -8
  151. package/quick-insert/empty-state/package.json +0 -10
  152. package/quick-insert/menu-root/package.json +0 -10
  153. package/quick-insert/menu-section/package.json +0 -10
  154. package/quick-insert/registered-menu-model/package.json +0 -10
  155. package/quick-insert/use-menu-list-height/package.json +0 -10
  156. package/quick-insert/use-menu-popup-sizing/package.json +0 -10
  157. package/quick-insert/use-search-analytics/package.json +0 -10
  158. package/type-ahead/item-rank/package.json +0 -10
  159. package/type-ahead-surface-context/package.json +0 -10
  160. /package/dist/cjs/{type-ahead → registered-menu}/item-rank.js +0 -0
  161. /package/dist/es2019/{type-ahead → registered-menu}/item-rank.js +0 -0
  162. /package/dist/esm/{type-ahead → registered-menu}/item-rank.js +0 -0
  163. /package/dist/types/{type-ahead → registered-menu}/item-rank.d.ts +0 -0
@@ -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,
@@ -0,0 +1,126 @@
1
+ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
2
+ import { useCallback, useLayoutEffect, useMemo, useState } from 'react';
3
+ import { getComponentIdentity } from '@atlaskit/editor-ui-control-model/surface-renderer';
4
+ import { getRegisteredMenuRows } from './getRegisteredMenuRows';
5
+ import { useRegisteredMenuSelection } from './useRegisteredMenuSelection';
6
+ /**
7
+ * Connects menu rows to keyboard selection and tracks which item is active through
8
+ * keyboard, pointer and focus events. Selection controls navigation; activation lets
9
+ * the caller show item-specific feedback, such as a preview. A changed reset key
10
+ * starts navigation again and clears the active item.
11
+ */
12
+ export var useRegisteredMenu = function useRegisteredMenu(_ref) {
13
+ var model = _ref.model,
14
+ resetKey = _ref.resetKey;
15
+ var _useMemo = useMemo(function () {
16
+ var rows = getRegisteredMenuRows(model);
17
+ var selectableItems = [];
18
+ var selectableItemIdentities = [];
19
+ rows.forEach(function (row) {
20
+ if (row.type === 'menu-item') {
21
+ selectableItems.push(row);
22
+ selectableItemIdentities.push(getComponentIdentity(row));
23
+ }
24
+ });
25
+ // The footer participates in navigation but is rendered outside the scrolling rows.
26
+ if (model.footer) {
27
+ selectableItemIdentities.push(getComponentIdentity(model.footer));
28
+ }
29
+ return {
30
+ rows: rows,
31
+ selectableItems: selectableItems,
32
+ selectableItemIdentities: selectableItemIdentities
33
+ };
34
+ }, [model]),
35
+ rows = _useMemo.rows,
36
+ selectableItems = _useMemo.selectableItems,
37
+ selectableItemIdentities = _useMemo.selectableItemIdentities;
38
+ var selection = useRegisteredMenuSelection({
39
+ identities: selectableItemIdentities,
40
+ resetKey: resetKey
41
+ });
42
+ var selectedItemIndex = selection.selectedIndex,
43
+ select = selection.select;
44
+ var _useState = useState(),
45
+ _useState2 = _slicedToArray(_useState, 2),
46
+ activation = _useState2[0],
47
+ setItemActivation = _useState2[1];
48
+ var activeItemKey = (activation === null || activation === void 0 ? void 0 : activation.model) === model && activation.resetKey === resetKey ? activation.itemKey : undefined;
49
+ useLayoutEffect(function () {
50
+ setItemActivation(undefined);
51
+ }, [model, resetKey]);
52
+ var activateKeyboardItem = useCallback(function (index) {
53
+ var item = selectableItems[index];
54
+ setItemActivation(item ? {
55
+ itemKey: item.key,
56
+ model: model,
57
+ resetKey: resetKey,
58
+ source: 'keyboard'
59
+ } : undefined);
60
+ }, [model, resetKey, selectableItems]);
61
+ var selectNext = useCallback(function () {
62
+ activateKeyboardItem(selection.selectNext());
63
+ }, [selection.selectNext, activateKeyboardItem]);
64
+ var selectPrevious = useCallback(function () {
65
+ activateKeyboardItem(selection.selectPrevious());
66
+ }, [selection.selectPrevious, activateKeyboardItem]);
67
+ var onItemHover = useCallback(function (index, itemKey) {
68
+ select(index);
69
+ setItemActivation(function (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: itemKey,
75
+ model: model,
76
+ resetKey: resetKey,
77
+ source: 'pointer'
78
+ } : undefined;
79
+ });
80
+ }, [model, resetKey, select]);
81
+ var onItemFocus = useCallback(function (index, itemKey) {
82
+ select(index);
83
+ setItemActivation(function (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: itemKey,
89
+ model: model,
90
+ resetKey: resetKey,
91
+ source: 'keyboard'
92
+ } : undefined;
93
+ });
94
+ }, [model, resetKey, select]);
95
+ var onItemLeave = useCallback(function (itemKey) {
96
+ setItemActivation(function (current) {
97
+ return (current === null || current === void 0 ? void 0 : current.source) === 'pointer' && current.itemKey === itemKey ? undefined : current;
98
+ });
99
+ }, []);
100
+ var onItemBlur = useCallback(function (itemKey) {
101
+ setItemActivation(function (current) {
102
+ return (current === null || current === void 0 ? void 0 : current.itemKey) === itemKey ? undefined : current;
103
+ });
104
+ }, []);
105
+ var onItemVisibilityChange = useCallback(function (itemKey, isVisible) {
106
+ if (!isVisible) {
107
+ setItemActivation(function (current) {
108
+ return (current === null || current === void 0 ? void 0 : current.source) === 'pointer' && current.itemKey === itemKey ? undefined : current;
109
+ });
110
+ }
111
+ }, []);
112
+ return {
113
+ rows: rows,
114
+ selectableItems: selectableItems,
115
+ selectedItemIndex: selectedItemIndex,
116
+ select: select,
117
+ selectNext: selectNext,
118
+ selectPrevious: selectPrevious,
119
+ activeItemKey: activeItemKey,
120
+ onItemHover: onItemHover,
121
+ onItemFocus: onItemFocus,
122
+ onItemLeave: onItemLeave,
123
+ onItemBlur: onItemBlur,
124
+ onItemVisibilityChange: onItemVisibilityChange
125
+ };
126
+ };
@@ -0,0 +1,46 @@
1
+ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
2
+ import { useCallback, useLayoutEffect, useMemo, useRef, useState } from 'react';
3
+ /**
4
+ * Resets keyboard selection when the ordered items or reset key changes.
5
+ * The caller chooses the key, for example a search term or the current category.
6
+ */
7
+ export var useRegisteredMenuSelection = function useRegisteredMenuSelection(_ref) {
8
+ var identities = _ref.identities,
9
+ resetKey = _ref.resetKey;
10
+ var _useState = useState(function () {
11
+ return identities.length > 0 ? 0 : -1;
12
+ }),
13
+ _useState2 = _slicedToArray(_useState, 2),
14
+ selectedIndex = _useState2[0],
15
+ setSelectedIndex = _useState2[1];
16
+ var selectedIndexRef = useRef(selectedIndex);
17
+ var identitySignature = useMemo(function () {
18
+ return JSON.stringify(identities);
19
+ }, [identities]);
20
+ var itemCount = identities.length;
21
+ var select = useCallback(function (index) {
22
+ selectedIndexRef.current = index;
23
+ setSelectedIndex(index);
24
+ }, []);
25
+ useLayoutEffect(function () {
26
+ select(itemCount > 0 ? 0 : -1);
27
+ }, [identitySignature, itemCount, resetKey, select]);
28
+ var selectNext = useCallback(function () {
29
+ var currentIndex = selectedIndexRef.current;
30
+ var nextIndex = itemCount === 0 ? -1 : currentIndex < 0 ? 0 : (currentIndex + 1) % itemCount;
31
+ select(nextIndex);
32
+ return nextIndex;
33
+ }, [itemCount, select]);
34
+ var selectPrevious = useCallback(function () {
35
+ var currentIndex = selectedIndexRef.current;
36
+ var previousIndex = itemCount === 0 ? -1 : currentIndex <= 0 ? itemCount - 1 : currentIndex - 1;
37
+ select(previousIndex);
38
+ return previousIndex;
39
+ }, [itemCount, select]);
40
+ return {
41
+ selectedIndex: selectedIndex,
42
+ select: select,
43
+ selectNext: selectNext,
44
+ selectPrevious: selectPrevious
45
+ };
46
+ };
@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
20
20
  import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
21
21
  import Layer from '../Layer';
22
22
  var packageName = "@atlaskit/editor-common";
23
- var packageVersion = "133.7.1";
23
+ var packageVersion = "134.0.0";
24
24
  var halfFocusRing = 1;
25
25
  var dropOffset = '0, 8';
26
26
  // Ignored via go/ees005
@@ -1,6 +1,10 @@
1
1
  import type { NodeType } from '@atlaskit/editor-prosemirror/model';
2
2
  import { Fragment, Node } from '@atlaskit/editor-prosemirror/model';
3
3
  import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
4
+ /** Builds an insertion transaction using the editor state and position supplied by the host. */
5
+ export type InsertContentCallback = (content?: Node | object | string | Fragment, options?: {
6
+ selectInlineNode?: boolean;
7
+ }) => Transaction;
4
8
  export type InsertableContent = Node | Fragment;
5
9
  export declare enum LookDirection {
6
10
  Before = "before",
@@ -11,7 +15,7 @@ export declare const safeInsert: (content: InsertableContent, position?: number)
11
15
  /**
12
16
  * Method extracted from typeahead plugin to be shared with the element browser on handling element insertion.
13
17
  */
14
- export declare const insertSelectedItem: (maybeNode?: Node | Object | string | Fragment, opts?: {
18
+ export declare const insertSelectedItem: (maybeNode?: Node | object | string | Fragment, opts?: {
15
19
  selectInlineNode?: boolean;
16
20
  }) => (state: EditorState, tr: Transaction, start: number) => Transaction;
17
21
  /**
@@ -3,13 +3,12 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
3
3
  import type { EditorView } from '@atlaskit/editor-prosemirror/view';
4
4
  import type { SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
5
5
  import type { INPUT_METHOD } from '../analytics';
6
- import type { TypeAheadInsert } from '../types';
6
+ import type { InsertContentCallback } from '../insert';
7
7
  export type QuickInsertSelectionHandler = (context: {
8
- insert: TypeAheadInsert;
8
+ insert: InsertContentCallback;
9
9
  source: INPUT_METHOD.ELEMENT_BROWSER | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
10
10
  }) => Transaction | false | void;
11
11
  export type QuickInsertContextValue = {
12
- activePreviewItemKey?: string;
13
12
  editorView: EditorView;
14
13
  isOffline: boolean;
15
14
  item?: {
@@ -18,10 +17,12 @@ export type QuickInsertContextValue = {
18
17
  isPreviewActive?: boolean;
19
18
  isSelected: boolean;
20
19
  };
21
- menuOpenId?: symbol;
22
20
  popupsMountPoint?: HTMLElement;
23
21
  select: (selectionHandler: QuickInsertSelectionHandler) => void;
24
- surface: 'typeahead' | 'toolbar' | 'element-browser';
25
22
  surfaceContext?: SurfaceContext;
26
23
  };
24
+ /**
25
+ * Gives Quick Insert items access to the editor and the function for selecting a command.
26
+ * The menu supplies shared values; each item adds its selected and preview state.
27
+ */
27
28
  export declare const QuickInsertContext: Context<QuickInsertContextValue | null>;
@@ -2,11 +2,11 @@ import React from 'react';
2
2
  import type { Transaction } from '@atlaskit/editor-prosemirror/state';
3
3
  import type { EditorView } from '@atlaskit/editor-prosemirror/view';
4
4
  import type { INPUT_METHOD } from '../analytics';
5
- import type { TypeAheadInsert } from '../types';
5
+ import type { InsertContentCallback } from '../insert';
6
6
  import type { QuickInsertPreview } from './preview';
7
7
  export type OnSelectContext = {
8
8
  editorView: EditorView;
9
- insert: TypeAheadInsert;
9
+ insert: InsertContentCallback;
10
10
  source: INPUT_METHOD.ELEMENT_BROWSER | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
11
11
  };
12
12
  export type QuickInsertMenuItemProps = {
@@ -1,3 +1,3 @@
1
- import type { RegisteredItemRankResolver } from '../type-ahead/item-rank';
1
+ import type { RegisteredItemRankResolver } from '../registered-menu/item-rank';
2
2
  /** Recommendations and navigation controls retain their policy-defined order. */
3
3
  export declare const createQuickInsertRankResolver: (getItemRank?: RegisteredItemRankResolver) => RegisteredItemRankResolver | undefined;
@@ -0,0 +1,2 @@
1
+ import type { Context } from 'react';
2
+ export declare const ActiveMenuItemKeyContext: Context<string | undefined>;
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ export declare const MeasuredRow: ({ children, isScrolling, isVisible, measure, onMeasured, paddingBlockStart, paddingBlockEnd, }: {
3
+ children: React.ReactNode;
4
+ isScrolling?: boolean;
5
+ isVisible: boolean;
6
+ measure: () => void;
7
+ onMeasured: () => void;
8
+ paddingBlockEnd?: 'space.100';
9
+ paddingBlockStart?: 'space.100';
10
+ }) => React.JSX.Element;
@@ -0,0 +1,4 @@
1
+ import { type Context } from 'react';
2
+ import type { RegisteredMenuContextValue } from './types';
3
+ export declare const RegisteredMenuContext: Context<RegisteredMenuContextValue | null>;
4
+ export declare const useRegisteredMenuContext: () => RegisteredMenuContextValue;
@@ -0,0 +1,31 @@
1
+ import React from 'react';
2
+ import type { RegisterMenuItem, RegisterMenuSection } from '@atlaskit/editor-ui-control-model/types';
3
+ import type { RegisteredMenuListItemIdParams } from './RegisteredMenuListItemRow';
4
+ import type { RegisteredMenuItemProps } from './types';
5
+ export type RegisteredMenuListProps = {
6
+ activeItemKey?: string;
7
+ containerRole?: 'presentation';
8
+ getItemId: (params: RegisteredMenuListItemIdParams) => string;
9
+ hasScrollPadding?: boolean;
10
+ Item: React.ComponentType<RegisteredMenuItemProps>;
11
+ lastRowPadding?: 'none' | 'space.100';
12
+ maxHeight: number;
13
+ omitAriaReadonly?: boolean;
14
+ onItemBlur: (itemKey: string) => void;
15
+ onItemFocus: (itemIndex: number, itemKey?: string) => void;
16
+ onItemHover: (itemIndex: number, itemKey?: string) => void;
17
+ onItemLeave: (itemKey: string) => void;
18
+ onItemVisibilityChange: (itemKey: string, isVisible: boolean) => void;
19
+ onRenderedItemsChange?: (range: {
20
+ startIndex: number;
21
+ stopIndex: number;
22
+ }) => void;
23
+ role?: 'presentation' | 'group';
24
+ rows: Array<RegisterMenuItem | RegisterMenuSection>;
25
+ scrollResetKey?: string | number | symbol;
26
+ scrollTo?: 'selected' | 'top-on-reset';
27
+ selectedItemIndex: number;
28
+ tabIndex?: number | null;
29
+ width: number;
30
+ };
31
+ export declare const RegisteredMenuList: ({ rows, Item, selectedItemIndex, activeItemKey, maxHeight, width, getItemId, onItemHover, onItemFocus, onItemLeave, onItemBlur, onItemVisibilityChange, onRenderedItemsChange, scrollResetKey, role, containerRole, tabIndex, omitAriaReadonly, hasScrollPadding, lastRowPadding, scrollTo, }: RegisteredMenuListProps) => React.JSX.Element | null;
@@ -0,0 +1,28 @@
1
+ import React from 'react';
2
+ import type { RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
3
+ import type { RegisteredMenuItemProps } from './types';
4
+ export type RegisteredMenuListItemIdParams = {
5
+ itemIndex: number;
6
+ rowIndex: number;
7
+ };
8
+ export type RegisteredMenuListItemRowProps = {
9
+ getItemId: (params: RegisteredMenuListItemIdParams) => string;
10
+ isVisible: boolean;
11
+ Item: React.ComponentType<RegisteredMenuItemProps>;
12
+ itemIndex: number;
13
+ onItemBlur: (itemKey: string) => void;
14
+ onItemFocus: (itemIndex: number, itemKey?: string) => void;
15
+ onItemHover: (itemIndex: number, itemKey?: string) => void;
16
+ onItemLeave: (itemKey: string) => void;
17
+ onItemVisibilityChange: (itemKey: string, isVisible: boolean) => void;
18
+ registration: RegisterMenuItem;
19
+ rowIndex: number;
20
+ selectedItemIndex: number;
21
+ };
22
+ /**
23
+ * Connects a rendered item to the list's active state and interaction callbacks.
24
+ * The list may reuse this row while scrolling, so context keeps its active styling
25
+ * current. The wrapper handles events without requiring registered components to
26
+ * forward them, and keeps the item active when focus moves between its children.
27
+ */
28
+ export declare const RegisteredMenuListItemRow: ({ Item, getItemId, itemIndex, isVisible, onItemBlur, onItemFocus, onItemHover, onItemLeave, onItemVisibilityChange, registration, rowIndex, selectedItemIndex, }: RegisteredMenuListItemRowProps) => React.JSX.Element;
@@ -0,0 +1,7 @@
1
+ import { type ContextToken, type SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
2
+ export type RegisteredMenuSurfaceContext = {
3
+ readonly menuOpenId: symbol;
4
+ readonly surface: 'typeahead' | 'toolbar' | 'element-browser';
5
+ };
6
+ export declare const REGISTERED_MENU_SURFACE_CONTEXT: ContextToken<RegisteredMenuSurfaceContext>;
7
+ export declare const createRegisteredMenuSurfaceContext: (value: RegisteredMenuSurfaceContext) => SurfaceContext;
@@ -0,0 +1,4 @@
1
+ import type { RegisterMenuItem, RegisterMenuSection } from '@atlaskit/editor-ui-control-model/types';
2
+ import type { RegisteredMenuModel } from './types';
3
+ export type RegisteredMenuRow = RegisterMenuItem | RegisterMenuSection;
4
+ export declare const getRegisteredMenuRows: (model: RegisteredMenuModel) => RegisteredMenuRow[];
@@ -0,0 +1,55 @@
1
+ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
2
+ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
3
+ import type { SurfaceIdentifier } from '@atlaskit/editor-ui-control-model/surface-renderer/types';
4
+ import type { RegisterComponent, RegisterMenuItem, RegisterMenuSection, SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
5
+ import type { InsertContentCallback } from '../insert';
6
+ import type { RegisteredItemRankResolver } from './item-rank';
7
+ export type RegisteredMenuSection = [RegisterMenuSection, ...RegisterMenuItem[]];
8
+ export type RegisteredMenuModel = {
9
+ fallbackItems: RegisterMenuItem[];
10
+ footer: RegisterMenuItem | undefined;
11
+ root: RegisterComponent | undefined;
12
+ sections: RegisteredMenuSection[];
13
+ };
14
+ export type RegisteredMenuItemProps = {
15
+ id: string;
16
+ isActive: boolean;
17
+ isSelected: boolean;
18
+ registration: RegisterMenuItem;
19
+ };
20
+ /**
21
+ * A menu exposes its navigation and accessibility state so the host can connect
22
+ * the element that has focus. The menu does not need to know whether that element is an input.
23
+ */
24
+ export type RegisteredMenuInteraction = {
25
+ activeDescendantId?: string;
26
+ /** Includes any interactive portals owned by this menu. */
27
+ containsTarget: (target: Node) => boolean;
28
+ expanded: boolean;
29
+ label: string;
30
+ listId: string;
31
+ onClose?: () => void;
32
+ /** Return true when handled so the controlling input can suppress its default behavior. */
33
+ onKeyDown: (event: KeyboardEvent) => boolean;
34
+ optionCount: number;
35
+ selectNext: () => void;
36
+ selectPrevious: () => void;
37
+ };
38
+ export type RegisteredMenuSelection = (insert: InsertContentCallback) => Transaction | false | void;
39
+ /** Editor and session values supplied by the host to the registered menu root. */
40
+ export type RegisteredMenuContextValue = {
41
+ components: RegisterComponent[];
42
+ editorView: EditorView;
43
+ getItemRank?: RegisteredItemRankResolver;
44
+ isOffline: boolean;
45
+ maxHeight?: number;
46
+ menuOpenId: symbol;
47
+ onClose: () => void;
48
+ /** Mount point for auxiliary portals such as item previews. The host owns the menu popup. */
49
+ portalMountPoint?: HTMLElement;
50
+ registerInteraction: (interaction: RegisteredMenuInteraction) => () => void;
51
+ query?: string;
52
+ rootComponent: SurfaceIdentifier;
53
+ select?: (selection: RegisteredMenuSelection) => void;
54
+ surfaceContext: SurfaceContext;
55
+ };
@@ -1,5 +1,9 @@
1
1
  import type { CellMeasurerCache } from 'react-virtualized/dist/commonjs/CellMeasurer';
2
- /** Keep the list viewport in sync with measured rows, including short search results. */
2
+ /**
3
+ * Fits the scrolling viewport to the total row height, so short menus do not leave
4
+ * empty space below their items. Rows can change height after rendering. Height
5
+ * updates wait for the next frame so all row measurements are included.
6
+ */
3
7
  export declare function useMenuListHeight(cache: CellMeasurerCache, rowCount: number, rowKeySignature: string): {
4
8
  height: number;
5
9
  updateHeight: () => void;
@@ -6,6 +6,10 @@ type Options = {
6
6
  scrollableElement?: HTMLElement;
7
7
  target?: HTMLElement | null;
8
8
  };
9
- /** Constrain menu height to the available space; Popup chooses placement. */
9
+ /**
10
+ * Limits menu height to the space around its anchor as the page scrolls or resizes.
11
+ * It allows room above or below the anchor because Popup can choose either side.
12
+ * This hook controls height only; Popup still positions the menu.
13
+ */
10
14
  export declare function useMenuPopupSizing({ target, boundariesElement, scrollableElement, maxHeight, offset, isOpen, }: Options): number;
11
15
  export {};
@@ -0,0 +1,28 @@
1
+ import type { RegisterMenuItem, RegisterMenuSection } from '@atlaskit/editor-ui-control-model/types';
2
+ import type { RegisteredMenuModel } from './types';
3
+ type Options = {
4
+ model: RegisteredMenuModel;
5
+ resetKey?: string | number | symbol;
6
+ };
7
+ export type RegisteredMenuState = {
8
+ activeItemKey?: string;
9
+ onItemBlur: (itemKey: string) => void;
10
+ onItemFocus: (index: number, itemKey?: string) => void;
11
+ onItemHover: (index: number, itemKey?: string) => void;
12
+ onItemLeave: (itemKey: string) => void;
13
+ onItemVisibilityChange: (itemKey: string, isVisible: boolean) => void;
14
+ rows: Array<RegisterMenuItem | RegisterMenuSection>;
15
+ select: (index: number) => void;
16
+ selectableItems: RegisterMenuItem[];
17
+ selectedItemIndex: number;
18
+ selectNext: () => void;
19
+ selectPrevious: () => void;
20
+ };
21
+ /**
22
+ * Connects menu rows to keyboard selection and tracks which item is active through
23
+ * keyboard, pointer and focus events. Selection controls navigation; activation lets
24
+ * the caller show item-specific feedback, such as a preview. A changed reset key
25
+ * starts navigation again and clears the active item.
26
+ */
27
+ export declare const useRegisteredMenu: ({ model, resetKey }: Options) => RegisteredMenuState;
28
+ export {};
@@ -0,0 +1,16 @@
1
+ type Options = {
2
+ identities: readonly string[];
3
+ resetKey?: string | number | symbol;
4
+ };
5
+ type RegisteredMenuSelectionState = {
6
+ select: (index: number) => void;
7
+ selectedIndex: number;
8
+ selectNext: () => number;
9
+ selectPrevious: () => number;
10
+ };
11
+ /**
12
+ * Resets keyboard selection when the ordered items or reset key changes.
13
+ * The caller chooses the key, for example a search term or the current category.
14
+ */
15
+ export declare const useRegisteredMenuSelection: ({ identities, resetKey, }: Options) => RegisteredMenuSelectionState;
16
+ export {};
@@ -10,4 +10,3 @@ export declare enum SelectItemMode {
10
10
  SELECTED = "selected"
11
11
  }
12
12
  export { typeAheadListMessages } from './messages';
13
- export type { TypeAheadSurfaceContext } from './TypeAheadSurfaceContext';
@@ -7,7 +7,7 @@ export { AnnotationUpdateEmitter, AnnotationUpdateEvent } from './annotation/emi
7
7
  export type { AnnotationState, AnnotationUpdateEventPayloads, OnAnnotationClickPayload, } from './annotation/emitter';
8
8
  export type { AnnotationProviders, InlineCommentSelectionComponentProps, InlineCommentHoverComponentProps, InlineCommentViewComponentProps, InlineCommentAnnotationProvider, AnnotationByMatches, AnnotationActionResult, } from './annotation';
9
9
  export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue, GetResolvedEditorStateReason, } from './editor-actions';
10
- export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, TypeAheadSection, TypeAheadSectionTitleUpdate, } from './type-ahead';
10
+ export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, TypeAheadSection, TypeAheadSectionTitleUpdate, } from './type-ahead';
11
11
  export type { CommandDispatch, Command, HigherOrderCommand, Predicate } from './command';
12
12
  export type { FeatureFlags, FeatureFlagKey, GetEditorFeatureFlags } from './feature-flags';
13
13
  export type { Browsers, Range, DisableSpellcheckByBrowser } from './supported-browsers';
@@ -1,7 +1,7 @@
1
1
  import type Fuse from 'fuse.js';
2
2
  import type { IntlShape } from 'react-intl';
3
3
  import type { QuickInsertItem, QuickInsertProvider } from '../provider-factory';
4
- import type { RegisteredItemRankResolver } from '../type-ahead/item-rank';
4
+ import type { RegisteredItemRankResolver } from '../registered-menu/item-rank';
5
5
  import type { EmptyStateHandler } from './empty-state-handler';
6
6
  export type QuickInsertOptions = boolean | {
7
7
  disableDefaultItems?: boolean;
@@ -1,10 +1,10 @@
1
1
  import type { ReactElement, ReactNode } from 'react';
2
2
  import type { IntlShape } from 'react-intl';
3
- import type { Fragment, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
4
3
  import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
5
4
  import type { TypeAheadPayload } from '../analytics/types/type-ahead';
5
+ import type { InsertContentCallback } from '../insert';
6
+ import type { RegisteredItemRankResolver } from '../registered-menu/item-rank';
6
7
  import type { SelectItemMode, TypeAheadAvailableNodes } from '../type-ahead';
7
- import type { RegisteredItemRankResolver } from '../type-ahead/item-rank';
8
8
  import type { EditorCommand } from '../types';
9
9
  type TypeAheadForceSelectProps = {
10
10
  editorState: EditorState;
@@ -24,10 +24,7 @@ export type TypeAheadItemRenderProps = {
24
24
  onClick: () => void;
25
25
  onHover: () => void;
26
26
  };
27
- export type TypeAheadInsert = (node?: PMNode | object | string | Fragment, opts?: {
28
- selectInlineNode?: boolean;
29
- }) => Transaction;
30
- export type TypeAheadSelectItem = (state: EditorState, item: TypeAheadItem, insert: TypeAheadInsert, meta: {
27
+ export type TypeAheadSelectItem = (state: EditorState, item: TypeAheadItem, insert: InsertContentCallback, meta: {
31
28
  mode: SelectItemMode;
32
29
  query: string;
33
30
  sourceListItem: Array<TypeAheadItem>;
@@ -145,6 +142,12 @@ export type TypeAheadHandler = {
145
142
  onInvokeAnalytics?: TypeAheadPayload;
146
143
  /** Handler executes logic when TypeAhead opens */
147
144
  onOpen?: (editorState: EditorState) => void;
145
+ /**
146
+ * Registry key for a custom menu root. The root must call registerInteraction
147
+ * from RegisteredMenuContext so the host can show the popup and connect keyboard navigation.
148
+ * The same context supplies the current query and selection action.
149
+ */
150
+ registeredMenuKey?: string;
148
151
  /** Handler returns a transaction which inserts the TypeAheadItem into the doc */
149
152
  selectItem: TypeAheadSelectItem;
150
153
  /**