@primer/react 0.0.0-20260807144044 → 0.0.0-20260810174932
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,17 +1,17 @@
|
|
|
1
1
|
# @primer/react
|
|
2
2
|
|
|
3
|
-
## 0.0.0-
|
|
3
|
+
## 0.0.0-20260810174932
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
-
- [#8276](https://github.com/primer/react/pull/8276) [`d2b0e4c`](https://github.com/primer/react/commit/d2b0e4cc059dc6826d70383173b96cdfb4970a93) Thanks [@copilot-swe-agent](https://github.com/apps/copilot-swe-agent)! - Portal: Render nothing while server rendering and during hydration instead of accessing the DOM during render, fixing server rendering support. Client-only renders are unchanged and still mount portaled content in the same commit.
|
|
8
|
-
|
|
9
7
|
- Fake entry to force publishing
|
|
10
8
|
|
|
11
9
|
- [#8258](https://github.com/primer/react/pull/8258) [`edbcd94`](https://github.com/primer/react/commit/edbcd942354ff45148c2623be8b543ef8789a20f) Thanks [@llastflowers](https://github.com/llastflowers)! - Update `AvatarStack` to not reserve space when collapsed
|
|
12
10
|
|
|
13
11
|
- [#8273](https://github.com/primer/react/pull/8273) [`0c1e401`](https://github.com/primer/react/commit/0c1e401b6b0d57f95f8115ea90af78281751a766) Thanks [@liuliu-dev](https://github.com/liuliu-dev)! - NavList: Exclude group headings from navigation list item counts
|
|
14
12
|
|
|
13
|
+
- [#8260](https://github.com/primer/react/pull/8260) [`af3bbeb`](https://github.com/primer/react/commit/af3bbeb0c2bf7b277903066ef1ec3b1ef6ec1d70) Thanks [@liuliu-dev](https://github.com/liuliu-dev)! - UnderlineNav: Keep item icons visible by default at the medium breakpoint and above
|
|
14
|
+
|
|
15
15
|
## 38.35.0
|
|
16
16
|
|
|
17
17
|
### Minor Changes
|
package/dist/Portal/Portal.js
CHANGED
|
@@ -1,105 +1,43 @@
|
|
|
1
1
|
import useIsomorphicLayoutEffect from "../utils/useIsomorphicLayoutEffect.js";
|
|
2
2
|
import { PortalContext } from "./PortalContext.js";
|
|
3
3
|
import { DEFAULT_PORTAL_CONTAINER_NAME, ensureDefaultPortal, getPortalRoot } from "./portalRoot.js";
|
|
4
|
-
import {
|
|
5
|
-
import React, { useContext, useSyncExternalStore } from "react";
|
|
4
|
+
import React, { useContext } from "react";
|
|
6
5
|
import { createPortal } from "react-dom";
|
|
7
6
|
//#region src/Portal/Portal.tsx
|
|
8
|
-
const subscribe = () => () => {};
|
|
9
|
-
const getSnapshot = () => true;
|
|
10
|
-
const getServerSnapshot = () => false;
|
|
11
|
-
/**
|
|
12
|
-
* Returns `true` only when React is rendering on the client, and not as part of
|
|
13
|
-
* hydrating server-rendered markup.
|
|
14
|
-
*
|
|
15
|
-
* `Portal` needs this because React's server renderer throws when it encounters a
|
|
16
|
-
* portal, and portaled content is never part of the server-rendered markup.
|
|
17
|
-
*
|
|
18
|
-
* `useSyncExternalStore` is used rather than a `useEffect`/`useState` "is mounted"
|
|
19
|
-
* flag because it only defers the portal for the renders that need it: it returns
|
|
20
|
-
* `false` while server rendering and for the hydration pass (keeping hydration
|
|
21
|
-
* consistent with the server markup), but `true` from the very first render of a
|
|
22
|
-
* client-only render. That way client-rendered portals — the overwhelmingly common
|
|
23
|
-
* case for overlays, dialogs and menus — still mount their children in the same
|
|
24
|
-
* commit as the `Portal` itself, so refs into portaled content are populated by the
|
|
25
|
-
* time the parent's layout effects run.
|
|
26
|
-
*/
|
|
27
|
-
function useIsClientRender() {
|
|
28
|
-
return useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);
|
|
29
|
-
}
|
|
30
7
|
/**
|
|
31
8
|
* Creates a React Portal, placing all children in a separate physical DOM root node.
|
|
32
9
|
* @see https://reactjs.org/docs/portals.html
|
|
33
10
|
*/
|
|
34
|
-
const Portal = (
|
|
35
|
-
const $ = c(12);
|
|
36
|
-
const { children, onMount, containerName: _containerName } = t0;
|
|
11
|
+
const Portal = ({ children, onMount, containerName: _containerName }) => {
|
|
37
12
|
const { portalContainerName } = useContext(PortalContext);
|
|
38
|
-
const
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
$[0] = onMount;
|
|
46
|
-
$[1] = t1;
|
|
47
|
-
} else t1 = $[1];
|
|
48
|
-
useIsomorphicLayoutEffect(t1);
|
|
49
|
-
const [element] = React.useState(_temp);
|
|
50
|
-
let t2;
|
|
51
|
-
let t3;
|
|
52
|
-
if ($[2] !== _containerName || $[3] !== element || $[4] !== isClientRender || $[5] !== portalContainerName) {
|
|
53
|
-
t2 = () => {
|
|
54
|
-
var _onMountRef$current;
|
|
55
|
-
if (!element || !isClientRender) return;
|
|
56
|
-
let containerName = _containerName !== null && _containerName !== void 0 ? _containerName : portalContainerName;
|
|
57
|
-
if (containerName === void 0) {
|
|
58
|
-
containerName = DEFAULT_PORTAL_CONTAINER_NAME;
|
|
59
|
-
ensureDefaultPortal();
|
|
60
|
-
}
|
|
61
|
-
const parentElement = getPortalRoot(containerName);
|
|
62
|
-
if (!parentElement) throw new Error(`Portal container '${containerName}' is not yet registered. Container must be registered with registerPortalRoot before use.`);
|
|
63
|
-
parentElement.appendChild(element);
|
|
64
|
-
(_onMountRef$current = onMountRef.current) === null || _onMountRef$current === void 0 || _onMountRef$current.call(onMountRef);
|
|
65
|
-
return () => {
|
|
66
|
-
parentElement.removeChild(element);
|
|
67
|
-
};
|
|
68
|
-
};
|
|
69
|
-
t3 = [
|
|
70
|
-
element,
|
|
71
|
-
isClientRender,
|
|
72
|
-
_containerName,
|
|
73
|
-
portalContainerName
|
|
74
|
-
];
|
|
75
|
-
$[2] = _containerName;
|
|
76
|
-
$[3] = element;
|
|
77
|
-
$[4] = isClientRender;
|
|
78
|
-
$[5] = portalContainerName;
|
|
79
|
-
$[6] = t2;
|
|
80
|
-
$[7] = t3;
|
|
81
|
-
} else {
|
|
82
|
-
t2 = $[6];
|
|
83
|
-
t3 = $[7];
|
|
13
|
+
const elementRef = React.useRef(null);
|
|
14
|
+
if (!elementRef.current) {
|
|
15
|
+
const div = document.createElement("div");
|
|
16
|
+
div.setAttribute("data-component", "Portal");
|
|
17
|
+
div.style.position = "relative";
|
|
18
|
+
div.style.zIndex = "1";
|
|
19
|
+
elementRef.current = div;
|
|
84
20
|
}
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
21
|
+
const element = elementRef.current;
|
|
22
|
+
useIsomorphicLayoutEffect(() => {
|
|
23
|
+
let containerName = _containerName !== null && _containerName !== void 0 ? _containerName : portalContainerName;
|
|
24
|
+
if (containerName === void 0) {
|
|
25
|
+
containerName = DEFAULT_PORTAL_CONTAINER_NAME;
|
|
26
|
+
ensureDefaultPortal();
|
|
27
|
+
}
|
|
28
|
+
const parentElement = getPortalRoot(containerName);
|
|
29
|
+
if (!parentElement) throw new Error(`Portal container '${containerName}' is not yet registered. Container must be registered with registerPortalRoot before use.`);
|
|
30
|
+
parentElement.appendChild(element);
|
|
31
|
+
onMount === null || onMount === void 0 || onMount();
|
|
32
|
+
return () => {
|
|
33
|
+
parentElement.removeChild(element);
|
|
34
|
+
};
|
|
35
|
+
}, [
|
|
36
|
+
element,
|
|
37
|
+
_containerName,
|
|
38
|
+
portalContainerName
|
|
39
|
+
]);
|
|
40
|
+
return /*#__PURE__*/ createPortal(children, element);
|
|
95
41
|
};
|
|
96
|
-
function _temp() {
|
|
97
|
-
if (typeof document === "undefined") return null;
|
|
98
|
-
const div = document.createElement("div");
|
|
99
|
-
div.setAttribute("data-component", "Portal");
|
|
100
|
-
div.style.position = "relative";
|
|
101
|
-
div.style.zIndex = "1";
|
|
102
|
-
return div;
|
|
103
|
-
}
|
|
104
42
|
//#endregion
|
|
105
43
|
export { Portal };
|
|
@@ -17,8 +17,9 @@ type UnderlineNavProps = {
|
|
|
17
17
|
*/
|
|
18
18
|
variant?: 'inset' | 'flush';
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* Controls the container width below which icons are hidden to save space. Defaults to `medium`.
|
|
21
|
+
* To keep icons visible in a narrow container, use a smaller breakpoint such as `xsmall`, or set to `null` to
|
|
22
|
+
* always show icons.
|
|
22
23
|
*/
|
|
23
24
|
hideIconsBreakpoint?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge' | null;
|
|
24
25
|
};
|
|
@@ -22,7 +22,7 @@ const UnderlineNav = /*#__PURE__*/ forwardRef((t0, forwardedRef) => {
|
|
|
22
22
|
const as = t1 === void 0 ? "nav" : t1;
|
|
23
23
|
const loadingCounters = t2 === void 0 ? false : t2;
|
|
24
24
|
const variant = t3 === void 0 ? "inset" : t3;
|
|
25
|
-
const hideIconsBreakpoint = t4 === void 0 ? "
|
|
25
|
+
const hideIconsBreakpoint = t4 === void 0 ? "medium" : t4;
|
|
26
26
|
const backupRef = useRef(null);
|
|
27
27
|
const navRef = forwardedRef !== null && forwardedRef !== void 0 ? forwardedRef : backupRef;
|
|
28
28
|
const listRef = useRef(null);
|
|
@@ -1,83 +1,68 @@
|
|
|
1
|
-
import { c } from "react-compiler-runtime";
|
|
2
1
|
import React from "react";
|
|
3
2
|
import { iterateFocusableElements } from "@primer/behaviors/utils";
|
|
4
3
|
//#region src/hooks/useMenuInitialFocus.ts
|
|
5
4
|
const useMenuInitialFocus = (open, containerRef, anchorRef) => {
|
|
6
|
-
|
|
5
|
+
/**
|
|
6
|
+
* We need to pick the first element to focus based on how the menu was opened,
|
|
7
|
+
* however, we need to wait for the menu to be open to set focus.
|
|
8
|
+
* This is why we use set openingKey in state and have 2 effects
|
|
9
|
+
*/
|
|
7
10
|
const [openingGesture, setOpeningGesture] = React.useState(void 0);
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
const anchorElement = anchorRef === null || anchorRef === void 0 ? void 0 : anchorRef.current;
|
|
13
|
-
const clickHandler = (event) => {
|
|
14
|
-
if (event.detail !== 0) setOpeningGesture("mouse-click");
|
|
15
|
-
};
|
|
16
|
-
const keydownHandler = (event_0) => {
|
|
17
|
-
if ([
|
|
18
|
-
"Space",
|
|
19
|
-
"Enter",
|
|
20
|
-
"ArrowDown",
|
|
21
|
-
"ArrowUp"
|
|
22
|
-
].includes(event_0.code)) setOpeningGesture(event_0.code);
|
|
23
|
-
};
|
|
24
|
-
anchorElement === null || anchorElement === void 0 || anchorElement.addEventListener("click", clickHandler);
|
|
25
|
-
anchorElement === null || anchorElement === void 0 || anchorElement.addEventListener("keydown", keydownHandler);
|
|
26
|
-
return () => {
|
|
27
|
-
anchorElement === null || anchorElement === void 0 || anchorElement.removeEventListener("click", clickHandler);
|
|
28
|
-
anchorElement === null || anchorElement === void 0 || anchorElement.removeEventListener("keydown", keydownHandler);
|
|
29
|
-
};
|
|
11
|
+
React.useEffect(function inferOpeningKey() {
|
|
12
|
+
const anchorElement = anchorRef === null || anchorRef === void 0 ? void 0 : anchorRef.current;
|
|
13
|
+
const clickHandler = (event) => {
|
|
14
|
+
if (event.detail !== 0) setOpeningGesture("mouse-click");
|
|
30
15
|
};
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
$[1] = t0;
|
|
34
|
-
$[2] = t1;
|
|
35
|
-
} else {
|
|
36
|
-
t0 = $[1];
|
|
37
|
-
t1 = $[2];
|
|
38
|
-
}
|
|
39
|
-
React.useEffect(t0, t1);
|
|
40
|
-
let t2;
|
|
41
|
-
let t3;
|
|
42
|
-
if ($[3] !== anchorRef || $[4] !== containerRef || $[5] !== open || $[6] !== openingGesture) {
|
|
43
|
-
t2 = function moveFocusOnOpen() {
|
|
44
|
-
if (!open || !(containerRef !== null && containerRef !== void 0 && containerRef.current)) return;
|
|
45
|
-
const iterable = iterateFocusableElements(containerRef.current);
|
|
46
|
-
if (openingGesture === "mouse-click") if (anchorRef !== null && anchorRef !== void 0 && anchorRef.current) anchorRef.current.focus();
|
|
47
|
-
else throw new Error("For focus management, please attach anchorRef");
|
|
48
|
-
else if (openingGesture && [
|
|
49
|
-
"ArrowDown",
|
|
16
|
+
const keydownHandler = (event) => {
|
|
17
|
+
if ([
|
|
50
18
|
"Space",
|
|
51
|
-
"Enter"
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
setTimeout(() => firstElement_0 === null || firstElement_0 === void 0 ? void 0 : firstElement_0.focus());
|
|
62
|
-
}
|
|
19
|
+
"Enter",
|
|
20
|
+
"ArrowDown",
|
|
21
|
+
"ArrowUp"
|
|
22
|
+
].includes(event.code)) setOpeningGesture(event.code);
|
|
23
|
+
};
|
|
24
|
+
anchorElement === null || anchorElement === void 0 || anchorElement.addEventListener("click", clickHandler);
|
|
25
|
+
anchorElement === null || anchorElement === void 0 || anchorElement.addEventListener("keydown", keydownHandler);
|
|
26
|
+
return () => {
|
|
27
|
+
anchorElement === null || anchorElement === void 0 || anchorElement.removeEventListener("click", clickHandler);
|
|
28
|
+
anchorElement === null || anchorElement === void 0 || anchorElement.removeEventListener("keydown", keydownHandler);
|
|
63
29
|
};
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
30
|
+
}, [anchorRef]);
|
|
31
|
+
/**
|
|
32
|
+
* Pick the first element to focus based on the key used to open the Menu
|
|
33
|
+
* Click: anchor
|
|
34
|
+
* ArrowDown | Space | Enter: first element
|
|
35
|
+
* ArrowUp: last element
|
|
36
|
+
*/
|
|
37
|
+
React.useEffect(function moveFocusOnOpen() {
|
|
38
|
+
if (!open || !(containerRef !== null && containerRef !== void 0 && containerRef.current)) return;
|
|
39
|
+
const iterable = iterateFocusableElements(containerRef.current);
|
|
40
|
+
if (openingGesture === "mouse-click") if (anchorRef !== null && anchorRef !== void 0 && anchorRef.current) anchorRef.current.focus();
|
|
41
|
+
else throw new Error("For focus management, please attach anchorRef");
|
|
42
|
+
else if (openingGesture && [
|
|
43
|
+
"ArrowDown",
|
|
44
|
+
"Space",
|
|
45
|
+
"Enter"
|
|
46
|
+
].includes(openingGesture)) {
|
|
47
|
+
const firstElement = iterable.next().value;
|
|
48
|
+
/** We push imperative focus to the next tick to prevent React's batching */
|
|
49
|
+
setTimeout(() => firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus());
|
|
50
|
+
} else if ("ArrowUp" === openingGesture) {
|
|
51
|
+
const elements = [...iterable];
|
|
52
|
+
const lastElement = elements[elements.length - 1];
|
|
53
|
+
setTimeout(() => lastElement.focus());
|
|
54
|
+
} else {
|
|
55
|
+
/** if the menu was not opened with the anchor, we default to the first element
|
|
56
|
+
* for example: with keyboard shortcut (see stories/fixtures)
|
|
57
|
+
*/
|
|
58
|
+
const firstElement = iterable.next().value;
|
|
59
|
+
setTimeout(() => firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus());
|
|
60
|
+
}
|
|
61
|
+
}, [
|
|
62
|
+
open,
|
|
63
|
+
openingGesture,
|
|
64
|
+
anchorRef
|
|
65
|
+
]);
|
|
81
66
|
};
|
|
82
67
|
//#endregion
|
|
83
68
|
export { useMenuInitialFocus };
|
|
@@ -9042,7 +9042,7 @@
|
|
|
9042
9042
|
},
|
|
9043
9043
|
{
|
|
9044
9044
|
"id": "components-underlinenav-features--overflow-template",
|
|
9045
|
-
"code": "({ initialSelectedIndex = 1 }: { initialSelectedIndex?: number }) => {\n const [selectedIndex, setSelectedIndex] = React.useState<number | null>(\n initialSelectedIndex,\n )\n return (\n <UnderlineNav aria-label=\"Repository\">\n {items.map((item, index) => (\n <UnderlineNav.Item\n key={item.navigation}\n leadingVisual={item.icon}\n aria-current={index === selectedIndex ? 'page' : undefined}\n // Set so that navigation in interaction tests does not cause the\n // page to load the storybook iframe URL and instead keeps the test in\n // the local preview\n target=\"_self\"\n onSelect={(event) => {\n event.preventDefault()\n setSelectedIndex(index)\n }}\n counter={item.counter}\n href={item.href}\n >\n {item.navigation}\n </UnderlineNav.Item>\n ))}\n </UnderlineNav>\n )\n}"
|
|
9045
|
+
"code": "({ initialSelectedIndex = 1 }: { initialSelectedIndex?: number }) => {\n const [selectedIndex, setSelectedIndex] = React.useState<number | null>(\n initialSelectedIndex,\n )\n return (\n <UnderlineNav aria-label=\"Repository\" hideIconsBreakpoint=\"medium\">\n {items.map((item, index) => (\n <UnderlineNav.Item\n key={item.navigation}\n leadingVisual={item.icon}\n aria-current={index === selectedIndex ? 'page' : undefined}\n // Set so that navigation in interaction tests does not cause the\n // page to load the storybook iframe URL and instead keeps the test in\n // the local preview\n target=\"_self\"\n onSelect={(event) => {\n event.preventDefault()\n setSelectedIndex(index)\n }}\n counter={item.counter}\n href={item.href}\n >\n {item.navigation}\n </UnderlineNav.Item>\n ))}\n </UnderlineNav>\n )\n}"
|
|
9046
9046
|
},
|
|
9047
9047
|
{
|
|
9048
9048
|
"id": "components-underlinenav-features--overflow-on-narrow-screen",
|
|
@@ -9078,6 +9078,12 @@
|
|
|
9078
9078
|
"defaultValue": "false",
|
|
9079
9079
|
"description": "Whether the navigation items are in loading state. Component waits for all the counters to finish loading to prevent multiple layout shifts."
|
|
9080
9080
|
},
|
|
9081
|
+
{
|
|
9082
|
+
"name": "hideIconsBreakpoint",
|
|
9083
|
+
"type": "'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge' | null",
|
|
9084
|
+
"defaultValue": "'medium'",
|
|
9085
|
+
"description": "Controls the container width below which icons are hidden to save space. To keep icons visible in a narrow container, use a smaller breakpoint such as `xsmall`, or set to `null` to always show icons."
|
|
9086
|
+
},
|
|
9081
9087
|
{
|
|
9082
9088
|
"name": "variant",
|
|
9083
9089
|
"type": "'inset' | 'flush'",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@primer/react",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-20260810174932",
|
|
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",
|
|
@@ -110,12 +110,12 @@
|
|
|
110
110
|
"@primer/doc-gen": "^0.0.1",
|
|
111
111
|
"@primer/react-compiler-check": "^0.0.0",
|
|
112
112
|
"@rolldown/plugin-babel": "^0.2.3",
|
|
113
|
-
"@storybook/addon-a11y": "10.5.
|
|
114
|
-
"@storybook/addon-docs": "10.5.
|
|
115
|
-
"@storybook/addon-links": "10.5.
|
|
113
|
+
"@storybook/addon-a11y": "10.5.5",
|
|
114
|
+
"@storybook/addon-docs": "10.5.5",
|
|
115
|
+
"@storybook/addon-links": "10.5.5",
|
|
116
116
|
"@storybook/addon-mcp": "^0.7.0",
|
|
117
117
|
"@storybook/icons": "^2.1.0",
|
|
118
|
-
"@storybook/react-vite": "10.5.
|
|
118
|
+
"@storybook/react-vite": "10.5.5",
|
|
119
119
|
"@testing-library/dom": "^10.4.0",
|
|
120
120
|
"@testing-library/jest-dom": "^6.4.5",
|
|
121
121
|
"@testing-library/react": "^16.3.0",
|
|
@@ -172,7 +172,7 @@
|
|
|
172
172
|
"rolldown-plugin-dts": "^0.26.0",
|
|
173
173
|
"rolldown-plugin-import-css": "^0.0.0",
|
|
174
174
|
"rolldown-plugin-preserve-directives": "^0.0.0",
|
|
175
|
-
"storybook": "10.5.
|
|
175
|
+
"storybook": "10.5.5",
|
|
176
176
|
"terser": "5.36.0",
|
|
177
177
|
"ts-toolbelt": "9.6.0",
|
|
178
178
|
"tsx": "4.20.3",
|