@primer/react 0.0.0-20260311165335 → 0.0.0-20260311173344
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,13 +1,11 @@
|
|
|
1
1
|
# @primer/react
|
|
2
2
|
|
|
3
|
-
## 0.0.0-
|
|
3
|
+
## 0.0.0-20260311173344
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- Fake entry to force publishing
|
|
8
8
|
|
|
9
|
-
- [#7621](https://github.com/primer/react/pull/7621) [`43c0462`](https://github.com/primer/react/commit/43c0462f96db643168a9eb2bc84cd07b6acb6b90) Thanks [@hectahertz](https://github.com/hectahertz)! - Memoize SelectPanel overlayProps, focusTrapSettings, and preventBubbling to reduce allocations on re-renders
|
|
10
|
-
|
|
11
9
|
## 38.15.0
|
|
12
10
|
|
|
13
11
|
### Minor Changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SelectPanel.d.ts","sourceRoot":"","sources":["../../src/SelectPanel/SelectPanel.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAsC,KAAK,SAAS,EAAC,MAAM,wBAAwB,CAAA;AAC1F,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"SelectPanel.d.ts","sourceRoot":"","sources":["../../src/SelectPanel/SelectPanel.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAsC,KAAK,SAAS,EAAC,MAAM,wBAAwB,CAAA;AAC1F,OAAO,KAAK,EAAE,EAA+E,KAAK,GAAG,EAAC,MAAM,OAAO,CAAA;AACnH,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAA;AAE5D,OAAO,KAAK,EAAC,iCAAiC,EAAC,MAAM,oCAAoC,CAAA;AACzF,OAAO,KAAK,EAAC,uBAAuB,EAAC,MAAM,uBAAuB,CAAA;AAGlE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,YAAY,CAAA;AAE5C,OAAO,KAAK,EAAY,SAAS,EAAC,MAAM,IAAI,CAAA;AAiB5C,OAAO,KAAK,EAAC,WAAW,EAAE,eAAe,EAAC,MAAM,iBAAiB,CAAA;AAkCjE,UAAU,0BAA0B;IAClC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAA;IAC/B,gBAAgB,EAAE,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,KAAK,IAAI,CAAA;CAC5D;AAED,UAAU,yBAAyB;IACjC,QAAQ,EAAE,SAAS,EAAE,CAAA;IACrB,gBAAgB,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,IAAI,CAAA;CAClD;AAED,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,UAAU,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAClC,KAAK,CAAC,YAAY,CAAC,OAAO,eAAe,CAAC,GAC1C,KAAK,CAAC,YAAY,CAAC,OAAO,aAAa,CAAC,CAAA;AAE5C,UAAU,oBAAoB;IAG5B,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IAExC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IAC3C,YAAY,EAAE,CACZ,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,cAAc,GAAG,kBAAkB,GAAG,eAAe,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,KAC/F,IAAI,CAAA;IACT,eAAe,CAAC,EAAE,0BAA0B,CAAA;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;IACpC,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE;QAEP,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QACtC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;KACtC,CAAA;IACD,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,MAAM,CAAA;QAEb,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QACtC,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;QACtC,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;QAErC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;KACjC,CAAA;IACD;;OAEG;IAEH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IACzC,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAGD,KAAK,uBAAuB,GAAG;IAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;CAAC,GAAG;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,IAAI,CAAA;CAAC,CAAA;AAEvH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GACjD,IAAI,CAAC,uBAAuB,EAAE,kBAAkB,GAAG,SAAS,GAAG,SAAS,CAAC,GACzE,IAAI,CAAC,oBAAoB,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC,GACjE,iCAAiC,GACjC,CAAC,0BAA0B,GAAG,yBAAyB,CAAC,GACxD,uBAAuB,CAAA;AAgCzB,iBAAS,KAAK,CAAC,EACb,IAAI,EACJ,YAAY,EACZ,YAAkC,EAClC,SAAS,EAAE,iBAAiB,EAC5B,WAAW,EACX,eAAgC,EAChC,UAA4B,EAC5B,QAAQ,EACR,KAA0E,EAC1E,QAAQ,EACR,gBAAgB,EAChB,WAAW,EAAE,mBAAmB,EAChC,cAAc,EAAE,sBAAsB,EACtC,KAAK,EACL,MAAM,EACN,cAAc,EACd,YAAY,EACZ,OAAO,EACP,kBAA8B,EAC9B,SAAS,EACT,MAAM,EACN,KAAK,EACL,EAAE,EACF,OAAO,EACP,MAAM,EACN,QAAQ,EACR,OAAoB,EACpB,eAAe,EACf,wBAA+B,EAC/B,yBAAyB,EACzB,KAAK,EACL,aAAqB,EACrB,sBAAsB,EACtB,WAAW,EACX,GAAG,SAAS,EACb,EAAE,gBAAgB,GAAG,GAAG,CAAC,OAAO,CA0yBhC;AAED,QAAA,MAAM,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAM1C,CAAA;AAED,QAAA,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,GAAG,WAAW,CAM1D,CAAA;AAED,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;CAItB,CAAA"}
|
|
@@ -56,9 +56,6 @@ const focusZoneSettings = {
|
|
|
56
56
|
// Let FilteredActionList handle focus zone
|
|
57
57
|
disabled: true
|
|
58
58
|
};
|
|
59
|
-
const closeButtonProps = {
|
|
60
|
-
'aria-label': 'Cancel and close'
|
|
61
|
-
};
|
|
62
59
|
const areItemsEqual = (itemA, itemB) => {
|
|
63
60
|
// prefer checking equivality by item.id
|
|
64
61
|
if (typeof itemA.id !== 'undefined') return itemA.id === itemB.id;else return itemA === itemB;
|
|
@@ -540,9 +537,9 @@ function Panel({
|
|
|
540
537
|
prevOpenRef.current = open;
|
|
541
538
|
}
|
|
542
539
|
}, [open, resetSort]);
|
|
543
|
-
const focusTrapSettings =
|
|
540
|
+
const focusTrapSettings = {
|
|
544
541
|
initialFocusRef: inputRef || undefined
|
|
545
|
-
}
|
|
542
|
+
};
|
|
546
543
|
const extendedTextInputProps = useMemo(() => {
|
|
547
544
|
return {
|
|
548
545
|
className: classes.TextInput,
|
|
@@ -618,11 +615,9 @@ function Panel({
|
|
|
618
615
|
regular: 'anchored',
|
|
619
616
|
narrow: 'fullscreen'
|
|
620
617
|
} : undefined, 'anchored');
|
|
621
|
-
const preventBubbling =
|
|
622
|
-
var _overlayProps$onKeyDo;
|
|
623
|
-
overlayProps === null || overlayProps === void 0 ? void 0 : (_overlayProps$onKeyDo = overlayProps.onKeyDown) === null || _overlayProps$onKeyDo === void 0 ? void 0 : _overlayProps$onKeyDo.call(overlayProps, event);
|
|
624
|
-
|
|
618
|
+
const preventBubbling = customOnKeyDown => event => {
|
|
625
619
|
// skip if a TextInput has focus
|
|
620
|
+
customOnKeyDown === null || customOnKeyDown === void 0 ? void 0 : customOnKeyDown(event);
|
|
626
621
|
const activeElement = document.activeElement;
|
|
627
622
|
if (activeElement.tagName === 'INPUT' || activeElement.tagName === 'TEXTAREA') return;
|
|
628
623
|
|
|
@@ -637,25 +632,7 @@ function Panel({
|
|
|
637
632
|
|
|
638
633
|
// if this is a typeahead event, don't propagate outside of menu
|
|
639
634
|
event.stopPropagation();
|
|
640
|
-
}
|
|
641
|
-
const mergedOverlayProps = useMemo(() => ({
|
|
642
|
-
role: 'dialog',
|
|
643
|
-
'aria-labelledby': titleId,
|
|
644
|
-
'aria-describedby': subtitle ? subtitleId : undefined,
|
|
645
|
-
...overlayProps,
|
|
646
|
-
...(variant === 'modal' ? {
|
|
647
|
-
top: '50vh',
|
|
648
|
-
left: '50vw',
|
|
649
|
-
anchorSide: undefined
|
|
650
|
-
} : {}),
|
|
651
|
-
style: {
|
|
652
|
-
transform: variant === 'modal' ? 'translate(-50%, -50%)' : undefined,
|
|
653
|
-
...(isKeyboardVisible ? {
|
|
654
|
-
maxHeight: availablePanelHeight !== undefined ? `${availablePanelHeight}px` : 'auto'
|
|
655
|
-
} : {})
|
|
656
|
-
},
|
|
657
|
-
onKeyDown: preventBubbling
|
|
658
|
-
}), [titleId, subtitle, subtitleId, overlayProps, variant, isKeyboardVisible, availablePanelHeight, preventBubbling]);
|
|
635
|
+
};
|
|
659
636
|
return /*#__PURE__*/jsxs(Fragment, {
|
|
660
637
|
children: [/*#__PURE__*/jsx(AnchoredOverlay, {
|
|
661
638
|
renderAnchor: renderMenuAnchor,
|
|
@@ -664,7 +641,27 @@ function Panel({
|
|
|
664
641
|
open: open,
|
|
665
642
|
onOpen: onOpen,
|
|
666
643
|
onClose: onClose,
|
|
667
|
-
overlayProps:
|
|
644
|
+
overlayProps: {
|
|
645
|
+
role: 'dialog',
|
|
646
|
+
'aria-labelledby': titleId,
|
|
647
|
+
'aria-describedby': subtitle ? subtitleId : undefined,
|
|
648
|
+
...overlayProps,
|
|
649
|
+
...(variant === 'modal' ? {
|
|
650
|
+
/* override AnchoredOverlay position */
|
|
651
|
+
top: '50vh',
|
|
652
|
+
left: '50vw',
|
|
653
|
+
anchorSide: undefined
|
|
654
|
+
} : {}),
|
|
655
|
+
style: {
|
|
656
|
+
/* override AnchoredOverlay position */
|
|
657
|
+
transform: variant === 'modal' ? 'translate(-50%, -50%)' : undefined,
|
|
658
|
+
// set maxHeight based on calculated availablePanelHeight when keyboard is visible
|
|
659
|
+
...(isKeyboardVisible ? {
|
|
660
|
+
maxHeight: availablePanelHeight !== undefined ? `${availablePanelHeight}px` : 'auto'
|
|
661
|
+
} : {})
|
|
662
|
+
},
|
|
663
|
+
onKeyDown: preventBubbling(overlayProps === null || overlayProps === void 0 ? void 0 : overlayProps.onKeyDown)
|
|
664
|
+
},
|
|
668
665
|
focusTrapSettings: focusTrapSettings,
|
|
669
666
|
focusZoneSettings: focusZoneSettings,
|
|
670
667
|
height: height,
|
|
@@ -677,7 +674,9 @@ function Panel({
|
|
|
677
674
|
pinPosition: !height,
|
|
678
675
|
className: classes.Overlay,
|
|
679
676
|
displayCloseButton: showXCloseIcon,
|
|
680
|
-
closeButtonProps:
|
|
677
|
+
closeButtonProps: {
|
|
678
|
+
'aria-label': 'Cancel and close'
|
|
679
|
+
},
|
|
681
680
|
children: /*#__PURE__*/jsxs("div", {
|
|
682
681
|
className: classes.Wrapper,
|
|
683
682
|
"data-variant": variant,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useAnchoredPosition.d.ts","sourceRoot":"","sources":["../../src/hooks/useAnchoredPosition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAC,cAAc,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAA;
|
|
1
|
+
{"version":3,"file":"useAnchoredPosition.d.ts","sourceRoot":"","sources":["../../src/hooks/useAnchoredPosition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAC,cAAc,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAA;AA0BvE,MAAM,WAAW,4BAA6B,SAAQ,OAAO,CAAC,gBAAgB,CAAC;IAC7E,kBAAkB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;IACpD,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;IAClD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,GAAG,SAAS,KAAK,IAAI,CAAA;CAClE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,CAAC,EAAE,4BAA4B,EACvC,YAAY,GAAE,KAAK,CAAC,cAAmB,GACtC;IACD,kBAAkB,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;IACnD,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;IACjD,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;CACrC,CA2GA"}
|
|
@@ -4,6 +4,26 @@ import { useProvidedRefOrCreate } from './useProvidedRefOrCreate.js';
|
|
|
4
4
|
import { useResizeObserver } from './useResizeObserver.js';
|
|
5
5
|
import useIsomorphicLayoutEffect from '../utils/useIsomorphicLayoutEffect.js';
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* Returns all scrollable ancestor elements of the given element, plus the window.
|
|
9
|
+
* An element is scrollable if its computed overflow/overflow-x/overflow-y is
|
|
10
|
+
* 'auto', 'scroll', or 'overlay'.
|
|
11
|
+
*/
|
|
12
|
+
function getScrollableAncestors(element) {
|
|
13
|
+
const scrollables = [];
|
|
14
|
+
let current = element.parentElement;
|
|
15
|
+
while (current) {
|
|
16
|
+
const style = getComputedStyle(current);
|
|
17
|
+
const overflowY = style.overflowY;
|
|
18
|
+
const overflowX = style.overflowX;
|
|
19
|
+
if (/auto|scroll|overlay/.test(overflowY) || /auto|scroll|overlay/.test(overflowX)) {
|
|
20
|
+
scrollables.push(current);
|
|
21
|
+
}
|
|
22
|
+
current = current.parentElement;
|
|
23
|
+
}
|
|
24
|
+
scrollables.push(window);
|
|
25
|
+
return scrollables;
|
|
26
|
+
}
|
|
7
27
|
/**
|
|
8
28
|
* Calculates the top and left values for an absolutely-positioned floating element
|
|
9
29
|
* to be anchored to some anchor element. Returns refs for the floating element
|
|
@@ -76,6 +96,32 @@ function useAnchoredPosition(settings, dependencies = []) {
|
|
|
76
96
|
useResizeObserver(updatePosition); // watches for changes in window size
|
|
77
97
|
useResizeObserver(updatePosition, floatingElementRef); // watches for changes in floating element size
|
|
78
98
|
|
|
99
|
+
// Recalculate position when any scrollable ancestor of the anchor scrolls.
|
|
100
|
+
// Uses requestAnimationFrame to avoid layout thrashing during scroll.
|
|
101
|
+
React.useEffect(() => {
|
|
102
|
+
const anchorEl = anchorElementRef.current;
|
|
103
|
+
if (!anchorEl) return;
|
|
104
|
+
let rafId = null;
|
|
105
|
+
const handleScroll = () => {
|
|
106
|
+
if (rafId !== null) return;
|
|
107
|
+
rafId = requestAnimationFrame(() => {
|
|
108
|
+
rafId = null;
|
|
109
|
+
updatePosition();
|
|
110
|
+
});
|
|
111
|
+
};
|
|
112
|
+
const scrollables = getScrollableAncestors(anchorEl);
|
|
113
|
+
for (const scrollable of scrollables) {
|
|
114
|
+
scrollable.addEventListener('scroll', handleScroll);
|
|
115
|
+
}
|
|
116
|
+
return () => {
|
|
117
|
+
for (const scrollable of scrollables) {
|
|
118
|
+
scrollable.removeEventListener('scroll', handleScroll);
|
|
119
|
+
}
|
|
120
|
+
if (rafId !== null) {
|
|
121
|
+
cancelAnimationFrame(rafId);
|
|
122
|
+
}
|
|
123
|
+
};
|
|
124
|
+
}, [anchorElementRef, updatePosition]);
|
|
79
125
|
return {
|
|
80
126
|
floatingElementRef,
|
|
81
127
|
anchorElementRef,
|
package/package.json
CHANGED