@primer/react 0.0.0-20260317151450 → 0.0.0-20260317151502

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.
package/CHANGELOG.md CHANGED
@@ -1,11 +1,13 @@
1
1
  # @primer/react
2
2
 
3
- ## 0.0.0-20260317151450
3
+ ## 0.0.0-20260317151502
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Fake entry to force publishing
8
8
 
9
+ - [#7549](https://github.com/primer/react/pull/7549) [`a5ccd0c`](https://github.com/primer/react/commit/a5ccd0c98e1153c0dadf48eaf5d50bd95e624428) Thanks [@hectahertz](https://github.com/hectahertz)! - perf(Autocomplete): eliminate re-renders on arrow-key navigation by converting highlightedItem to a ref
10
+
9
11
  ## 38.16.0
10
12
 
11
13
  ### Minor Changes
@@ -1 +1 @@
1
- {"version":3,"file":"AutocompleteMenu.d.ts","sourceRoot":"","sources":["../../src/Autocomplete/AutocompleteMenu.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAyD,MAAM,OAAO,CAAA;AAK7E,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,eAAe,CAAA;AAGtD,OAAO,KAAK,EAAC,cAAc,EAAE,YAAY,EAAW,MAAM,gBAAgB,CAAA;AAI1E,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,wBAAwB,CAAA;AAOrD,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAI,CAAA;AAClD,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG;IAE3E,aAAa,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IACrG,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,cAAc,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;CACvG,CAAA;AA4BD,KAAK,qBAAqB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,oBAAoB,GAAG;IAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;CAAC,CAAA;AAE3F,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,qBAAqB,IAAI;IAC3E;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG;QACf,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,eAAe,CAAC,KAAK,IAAI,CAAA;KACrE,CAAA;IAED;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,GAAG,IAAI,CAAA;IAE/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,KAAK,OAAO,CAAA;IAE1C;;;OAGG;IACH,KAAK,EAAE,CAAC,EAAE,CAAA;IAEV;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IAEH,eAAe,EAAE,MAAM,EAAE,CAAA;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IAE5D;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;IAExC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;IAEtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAA;IAEtC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAErE,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC5B,CAAA;AAUD,iBAAS,gBAAgB,CAAC,CAAC,SAAS,qBAAqB,EAAE,KAAK,EAAE,6BAA6B,CAAC,CAAC,CAAC,qBAqRjG;kBArRQ,gBAAgB;;;;AAyRzB,MAAM,MAAM,qBAAqB,GAAG,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAC3E,eAAe,gBAAgB,CAAA"}
1
+ {"version":3,"file":"AutocompleteMenu.d.ts","sourceRoot":"","sources":["../../src/Autocomplete/AutocompleteMenu.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAyD,MAAM,OAAO,CAAA;AAK7E,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,eAAe,CAAA;AAGtD,OAAO,KAAK,EAAC,cAAc,EAAE,YAAY,EAAW,MAAM,gBAAgB,CAAA;AAI1E,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,wBAAwB,CAAA;AAOrD,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAI,CAAA;AAClD,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG;IAE3E,aAAa,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IACrG,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,cAAc,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;CACvG,CAAA;AAoED,KAAK,qBAAqB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,oBAAoB,GAAG;IAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;CAAC,CAAA;AAE3F,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,qBAAqB,IAAI;IAC3E;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG;QACf,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,eAAe,CAAC,KAAK,IAAI,CAAA;KACrE,CAAA;IAED;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,GAAG,IAAI,CAAA;IAE/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,KAAK,OAAO,CAAA;IAE1C;;;OAGG;IACH,KAAK,EAAE,CAAC,EAAE,CAAA;IAEV;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IAEH,eAAe,EAAE,MAAM,EAAE,CAAA;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IAE5D;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;IAExC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;IAEtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAA;IAEtC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAErE,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC5B,CAAA;AAUD,iBAAS,gBAAgB,CAAC,CAAC,SAAS,qBAAqB,EAAE,KAAK,EAAE,6BAA6B,CAAC,CAAC,CAAC,qBAmRjG;kBAnRQ,gBAAgB;;;;AAuRzB,MAAM,MAAM,qBAAqB,GAAG,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAC3E,eAAe,gBAAgB,CAAA"}
@@ -1,4 +1,4 @@
1
- import React, { useContext, useRef, useState, useMemo, useEffect } from 'react';
1
+ import React, { useContext, useRef, useEffect, useState, useMemo } from 'react';
2
2
  import { debounce } from '@github/mini-throttle';
3
3
  import { announce } from '@primer/live-region-element';
4
4
  import { scrollIntoView } from '@primer/behaviors';
@@ -33,6 +33,41 @@ function getdefaultCheckedSelectionChange(setInputValueFn) {
33
33
  };
34
34
  }
35
35
  const isItemSelected = (itemId, selectedItemIds) => selectedItemIds.includes(itemId);
36
+
37
+ /**
38
+ * Memoized wrapper around ActionList.Item that skips re-rendering when props
39
+ * haven't changed. Combined with the `highlightedItem` ref (instead of state),
40
+ * arrow-key navigation no longer triggers re-renders of the item list.
41
+ */
42
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
43
+ const MemoizedAutocompleteItem = /*#__PURE__*/React.memo(function MemoizedAutocompleteItem({
44
+ item
45
+ }) {
46
+ const {
47
+ id,
48
+ onAction,
49
+ children,
50
+ text,
51
+ leadingVisual: LeadingVisual,
52
+ trailingVisual: TrailingVisual,
53
+ role,
54
+ ...itemProps
55
+ } = item;
56
+ // Remove key from itemProps so it doesn't spread onto the DOM
57
+ delete itemProps.key;
58
+ return /*#__PURE__*/jsxs(ActionList.Item, {
59
+ onSelect: () => onAction(item),
60
+ ...itemProps,
61
+ id: id,
62
+ "data-id": id,
63
+ role: role,
64
+ children: [LeadingVisual && /*#__PURE__*/jsx(ActionList.LeadingVisual, {
65
+ children: isElement(LeadingVisual) ? LeadingVisual : /*#__PURE__*/jsx(LeadingVisual, {})
66
+ }), children !== null && children !== void 0 ? children : text, TrailingVisual && /*#__PURE__*/jsx(ActionList.TrailingVisual, {
67
+ children: isElement(TrailingVisual) ? TrailingVisual : /*#__PURE__*/jsx(TrailingVisual, {})
68
+ })]
69
+ });
70
+ });
36
71
  function getItemById(itemId, items) {
37
72
  return items.find(item => item.id === itemId);
38
73
  }
@@ -85,7 +120,19 @@ function AutocompleteMenu(props) {
85
120
  } = props;
86
121
  const listContainerRef = useRef(null);
87
122
  const allItemsToRenderRef = useRef([]);
88
- const [highlightedItem, setHighlightedItem] = useState();
123
+ // Using a ref instead of state to avoid triggering a re-render of all items
124
+ // on every arrow-key press. The active styling was already handled via DOM by
125
+ // useFocusZone (data-is-active-descendant) before this change, but the
126
+ // previous useState caused React to re-render the entire item list anyway.
127
+ const highlightedItemRef = useRef();
128
+ const deferredInputValueRef = useRef(deferredInputValue);
129
+ const selectedItemIdsRef = useRef(selectedItemIds);
130
+ useEffect(() => {
131
+ deferredInputValueRef.current = deferredInputValue;
132
+ }, [deferredInputValue]);
133
+ useEffect(() => {
134
+ selectedItemIdsRef.current = selectedItemIds;
135
+ }, [selectedItemIds]);
89
136
  const [sortedItemIds, setSortedItemIds] = useState(items.map(({
90
137
  id: itemId
91
138
  }) => itemId));
@@ -95,7 +142,6 @@ function AutocompleteMenu(props) {
95
142
  ...selectableItem,
96
143
  role: 'option',
97
144
  id: selectableItem.id,
98
- active: (highlightedItem === null || highlightedItem === void 0 ? void 0 : highlightedItem.id) === selectableItem.id,
99
145
  selected: selectionVariant === 'multiple' ? selectedItemIds.includes(selectableItem.id) : undefined,
100
146
  onAction: item => {
101
147
  const otherSelectedItemIds = selectedItemIds.filter(selectedItemId => selectedItemId !== item.id);
@@ -112,7 +158,7 @@ function AutocompleteMenu(props) {
112
158
  }
113
159
  }
114
160
  };
115
- }), [highlightedItem, items, selectedItemIds, inputRef, onSelectedChange, selectionVariant, setAutocompleteSuggestion, setInputValue, setShowMenu]);
161
+ }), [items, selectedItemIds, inputRef, onSelectedChange, selectionVariant, setAutocompleteSuggestion, setInputValue, setShowMenu]);
116
162
  const itemSortOrderData = useMemo(() => sortedItemIds.reduce((acc, curr, i) => {
117
163
  acc[curr] = i;
118
164
  return acc;
@@ -126,7 +172,6 @@ function AutocompleteMenu(props) {
126
172
  ...addNewItem,
127
173
  role: 'option',
128
174
  key: addNewItem.id,
129
- active: (highlightedItem === null || highlightedItem === void 0 ? void 0 : highlightedItem.id) === addNewItem.id,
130
175
  selected: selectionVariant === 'multiple' ? selectedItemIds.includes(addNewItem.id) : undefined,
131
176
  leadingVisual: () => /*#__PURE__*/jsx(PlusIcon, {}),
132
177
  onAction: item => {
@@ -141,7 +186,7 @@ function AutocompleteMenu(props) {
141
186
  setAutocompleteSuggestion('');
142
187
  }
143
188
  }
144
- }] : [])], [sortedAndFilteredItemsToRender, addNewItem, setAutocompleteSuggestion, selectionVariant, setInputValue, generatedUniqueId, highlightedItem, selectedItemIds]);
189
+ }] : [])], [sortedAndFilteredItemsToRender, addNewItem, setAutocompleteSuggestion, selectionVariant, setInputValue, generatedUniqueId, selectedItemIds]);
145
190
  React.useEffect(() => {
146
191
  allItemsToRenderRef.current = allItemsToRender;
147
192
  });
@@ -159,13 +204,28 @@ function AutocompleteMenu(props) {
159
204
  activeDescendantFocus: inputRef,
160
205
  onActiveDescendantChanged: (current, _previous, directlyActivated) => {
161
206
  activeDescendantRef.current = current || null;
207
+
208
+ // Active styling was already handled via DOM before this change:
209
+ // useFocusZone sets `data-is-active-descendant` on the active element,
210
+ // and ActionList styles that attribute in CSS. The key change is that
211
+ // we no longer call setHighlightedItem (state), avoiding re-renders.
212
+
162
213
  if (current) {
214
+ var _selectedItem$text;
215
+ const currentLi = current.closest('li');
163
216
  const selectedItem = allItemsToRenderRef.current.find(item => {
164
- var _current$closest;
165
- return item.id === ((_current$closest = current.closest('li')) === null || _current$closest === void 0 ? void 0 : _current$closest.getAttribute('data-id'));
217
+ return item.id === (currentLi === null || currentLi === void 0 ? void 0 : currentLi.getAttribute('data-id'));
166
218
  });
167
- setHighlightedItem(selectedItem);
219
+ highlightedItemRef.current = selectedItem;
168
220
  setIsMenuDirectlyActivated(directlyActivated);
221
+
222
+ // Update autocomplete suggestion inline (moved from the useEffect
223
+ // that previously depended on highlightedItem state)
224
+ if (selectedItem !== null && selectedItem !== void 0 && (_selectedItem$text = selectedItem.text) !== null && _selectedItem$text !== void 0 && _selectedItem$text.startsWith(deferredInputValueRef.current) && !selectedItemIdsRef.current.includes(selectedItem.id)) {
225
+ setAutocompleteSuggestion(selectedItem.text);
226
+ } else {
227
+ setAutocompleteSuggestion('');
228
+ }
169
229
  }
170
230
  if (current && customScrollContainerRef && customScrollContainerRef.current && directlyActivated) {
171
231
  scrollIntoView(current, customScrollContainerRef.current, menuScrollMargins);
@@ -175,15 +235,16 @@ function AutocompleteMenu(props) {
175
235
  }
176
236
  }, [loading]);
177
237
  useEffect(() => {
178
- var _highlightedItem$text;
179
- // Use deferredInputValue to avoid running this effect on every keystroke
180
- // The Input component guards against stale suggestions
181
- if (highlightedItem !== null && highlightedItem !== void 0 && (_highlightedItem$text = highlightedItem.text) !== null && _highlightedItem$text !== void 0 && _highlightedItem$text.startsWith(deferredInputValue) && !selectedItemIds.includes(highlightedItem.id)) {
182
- setAutocompleteSuggestion(highlightedItem.text);
238
+ var _highlighted$text;
239
+ // When the input value changes, update the autocomplete suggestion based
240
+ // on the currently highlighted item (tracked via ref, not state).
241
+ const highlighted = highlightedItemRef.current;
242
+ if (highlighted !== null && highlighted !== void 0 && (_highlighted$text = highlighted.text) !== null && _highlighted$text !== void 0 && _highlighted$text.startsWith(deferredInputValue) && !selectedItemIds.includes(highlighted.id)) {
243
+ setAutocompleteSuggestion(highlighted.text);
183
244
  } else {
184
245
  setAutocompleteSuggestion('');
185
246
  }
186
- }, [highlightedItem, deferredInputValue, selectedItemIds, setAutocompleteSuggestion]);
247
+ }, [deferredInputValue, selectedItemIds, setAutocompleteSuggestion]);
187
248
  useEffect(() => {
188
249
  const itemIdSortResult = [...sortedItemIds].sort(sortOnCloseFn ? sortOnCloseFn : getDefaultSortFn(itemId => isItemSelected(itemId, selectedItemIds)));
189
250
  const sortResultMatchesState = itemIdSortResult.length === sortedItemIds.length && itemIdSortResult.every((element, index) => element === sortedItemIds[index]);
@@ -215,29 +276,10 @@ function AutocompleteMenu(props) {
215
276
  id: `${id}-listbox`,
216
277
  "aria-labelledby": ariaLabelledBy,
217
278
  children: allItemsToRender.map(item => {
218
- const {
219
- id,
220
- onAction,
221
- children,
222
- text,
223
- leadingVisual: LeadingVisual,
224
- trailingVisual: TrailingVisual,
225
- key,
226
- role,
227
- ...itemProps
228
- } = item;
229
- return /*#__PURE__*/jsxs(ActionList.Item, {
230
- onSelect: () => onAction(item),
231
- ...itemProps,
232
- id: id,
233
- "data-id": id,
234
- role: role,
235
- children: [LeadingVisual && /*#__PURE__*/jsx(ActionList.LeadingVisual, {
236
- children: isElement(LeadingVisual) ? LeadingVisual : /*#__PURE__*/jsx(LeadingVisual, {})
237
- }), children !== null && children !== void 0 ? children : text, TrailingVisual && /*#__PURE__*/jsx(ActionList.TrailingVisual, {
238
- children: isElement(TrailingVisual) ? TrailingVisual : /*#__PURE__*/jsx(TrailingVisual, {})
239
- })]
240
- }, key !== null && key !== void 0 ? key : id);
279
+ var _item$key;
280
+ return /*#__PURE__*/jsx(MemoizedAutocompleteItem, {
281
+ item: item
282
+ }, (_item$key = item.key) !== null && _item$key !== void 0 ? _item$key : item.id);
241
283
  })
242
284
  }) : emptyStateText !== false && emptyStateText !== null ? /*#__PURE__*/jsx("div", {
243
285
  className: classes.EmptyStateWrapper,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@primer/react",
3
3
  "type": "module",
4
- "version": "0.0.0-20260317151450",
4
+ "version": "0.0.0-20260317151502",
5
5
  "description": "An implementation of GitHub's Primer Design System using React",
6
6
  "main": "./dist/index.js",
7
7
  "module": "./dist/index.js",