@primer/react 38.34.0-rc.f86dc8614 → 38.34.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 (32) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/ActionList/Group.js +1 -1
  3. package/dist/ActionList/List.js +20 -14
  4. package/dist/AnchoredOverlay/AnchoredOverlay.js +6 -3
  5. package/dist/Autocomplete/AutocompleteInput.js +10 -7
  6. package/dist/ButtonGroup/ButtonGroup.js +15 -8
  7. package/dist/Checkbox/Checkbox.js +16 -9
  8. package/dist/Dialog/Dialog.js +12 -5
  9. package/dist/FeatureFlags/DefaultFeatureFlags.js +2 -1
  10. package/dist/FilteredActionList/FilteredActionList.js +31 -20
  11. package/dist/FilteredActionList/FilteredActionListInput.d.ts +1 -1
  12. package/dist/Link/Link.js +33 -33
  13. package/dist/Overlay/Overlay.js +1 -1
  14. package/dist/PageHeader/PageHeader.js +30 -21
  15. package/dist/SegmentedControl/{SegmentedControl-a004561f.css → SegmentedControl-de65527b.css} +2 -2
  16. package/dist/SegmentedControl/{SegmentedControl-a004561f.css.map → SegmentedControl-de65527b.css.map} +1 -1
  17. package/dist/SegmentedControl/SegmentedControl.module.css.js +1 -1
  18. package/dist/SegmentedControl/SegmentedControlButton.js +1 -1
  19. package/dist/SegmentedControl/SegmentedControlIconButton.js +1 -1
  20. package/dist/SelectPanel/SelectPanel.js +1 -1
  21. package/dist/TextInput/TextInput.js +13 -6
  22. package/dist/TooltipV2/Tooltip.js +18 -11
  23. package/dist/experimental/Tabs/Tabs.js +3 -2
  24. package/dist/experimental/Tabs/types.d.ts +10 -3
  25. package/dist/experimental/Tabs/useTabList.js +18 -10
  26. package/dist/experimental/UnderlinePanels/UnderlinePanels.js +69 -42
  27. package/dist/experimental/index.js +5 -5
  28. package/dist/hooks/useMergedRefs.d.ts +4 -4
  29. package/dist/hooks/useMergedRefs.js +8 -5
  30. package/dist/hooks/useProvidedRefOrCreate.d.ts +7 -10
  31. package/dist/hooks/useProvidedRefOrCreate.js +7 -10
  32. package/package.json +1 -2
@@ -3,15 +3,16 @@ import { useResizeObserver } from "../../hooks/useResizeObserver.js";
3
3
  import { useId as useId$1 } from "../../hooks/useId.js";
4
4
  import { isSlot } from "../../utils/is-slot.js";
5
5
  import { invariant } from "../../utils/invariant.js";
6
- import { createComponent } from "../../utils/create-component.js";
7
6
  import { UnderlineItem, UnderlineItemList, UnderlineWrapper } from "../../internal/components/UnderlineTabbedInterface.js";
8
7
  import UnderlinePanels_module_css_default from "./UnderlinePanels.module.css.js";
8
+ import { useTab } from "../Tabs/useTab.js";
9
+ import { useTabList } from "../Tabs/useTabList.js";
10
+ import { useTabPanel } from "../Tabs/useTabPanel.js";
11
+ import { Tabs } from "../Tabs/Tabs.js";
9
12
  import { clsx } from "clsx";
10
13
  import { jsx, jsxs } from "react/jsx-runtime";
11
14
  import React, { Children, cloneElement, createContext, isValidElement, useContext, useMemo, useRef, useState } from "react";
12
- import { TabContainerElement } from "@github/tab-container-element";
13
15
  //#region src/experimental/UnderlinePanels/UnderlinePanels.tsx
14
- const TabContainerComponent = createComponent(TabContainerElement, "tab-container");
15
16
  const UnderlinePanelsContext = /*#__PURE__*/ createContext({
16
17
  iconsVisible: true,
17
18
  loadingCounters: void 0
@@ -21,27 +22,43 @@ const UnderlinePanels = ({ "aria-label": ariaLabel, "aria-labelledby": ariaLabel
21
22
  const wrapperRef = useRef(null);
22
23
  const listRef = useRef(null);
23
24
  const parentId = useId$1(props.id);
24
- const [tabs, tabPanels, tabsHaveIcons] = useMemo(() => {
25
+ const [tabs, tabPanels, tabsHaveIcons, selectedFromProps] = useMemo(() => {
25
26
  let tabIndex = 0;
26
27
  let panelIndex = 0;
27
28
  const childrenWithProps = Children.map(children, (child) => {
28
- if (/*#__PURE__*/ isValidElement(child) && (child.type === Tab || isSlot(child, Tab))) return /*#__PURE__*/ cloneElement(child, { id: `${parentId}-tab-${tabIndex++}` });
29
- if (/*#__PURE__*/ isValidElement(child) && (child.type === Panel || isSlot(child, Panel))) return /*#__PURE__*/ cloneElement(child, { "aria-labelledby": `${parentId}-tab-${panelIndex++}` });
29
+ if (/*#__PURE__*/ isValidElement(child) && (child.type === Tab || isSlot(child, Tab))) return /*#__PURE__*/ cloneElement(child, { value: `${tabIndex++}` });
30
+ if (/*#__PURE__*/ isValidElement(child) && (child.type === Panel || isSlot(child, Panel))) return /*#__PURE__*/ cloneElement(child, { value: `${panelIndex++}` });
30
31
  return child;
31
32
  });
32
33
  const tabs = [];
33
34
  const tabPanels = [];
35
+ let selectedFromProps;
34
36
  for (const child of Children.toArray(childrenWithProps)) {
35
37
  if (!/*#__PURE__*/ isValidElement(child)) continue;
36
- if (child.type === Tab || isSlot(child, Tab)) tabs.push(child);
37
- else if (child.type === Panel || isSlot(child, Panel)) tabPanels.push(child);
38
+ if (child.type === Tab || isSlot(child, Tab)) {
39
+ const ariaSelected = child.props["aria-selected"];
40
+ if (ariaSelected === true || ariaSelected === "true") selectedFromProps = `${tabs.length}`;
41
+ tabs.push(child);
42
+ } else if (child.type === Panel || isSlot(child, Panel)) tabPanels.push(child);
38
43
  }
39
44
  return [
40
45
  tabs,
41
46
  tabPanels,
42
- tabs.some((tab) => /*#__PURE__*/ React.isValidElement(tab) && tab.props.icon)
47
+ tabs.some((tab) => /*#__PURE__*/ React.isValidElement(tab) && tab.props.icon),
48
+ selectedFromProps
43
49
  ];
44
- }, [children, parentId]);
50
+ }, [children]);
51
+ const [selectedValue, setSelectedValue] = useState(() => selectedFromProps !== null && selectedFromProps !== void 0 ? selectedFromProps : "0");
52
+ const [prevSelectedFromProps, setPrevSelectedFromProps] = useState(selectedFromProps);
53
+ if (selectedFromProps !== prevSelectedFromProps) {
54
+ setPrevSelectedFromProps(selectedFromProps);
55
+ if (selectedFromProps !== void 0 && selectedFromProps !== selectedValue) setSelectedValue(selectedFromProps);
56
+ }
57
+ const { tabListProps } = useTabList({
58
+ "aria-label": ariaLabel,
59
+ "aria-labelledby": ariaLabelledBy,
60
+ ref: listRef
61
+ });
45
62
  const contextValue = useMemo(() => ({
46
63
  iconsVisible,
47
64
  loadingCounters
@@ -68,55 +85,65 @@ const UnderlinePanels = ({ "aria-label": ariaLabel, "aria-labelledby": ariaLabel
68
85
  !(tabs.length === tabPanels.length) && invariant(false, `The number of tabs and panels must be equal. Counted ${tabs.length} tabs and ${tabPanels.length} panels.`);
69
86
  return /*#__PURE__*/ jsx(UnderlinePanelsContext.Provider, {
70
87
  value: contextValue,
71
- children: /*#__PURE__*/ jsxs(TabContainerComponent, { children: [/*#__PURE__*/ jsx(UnderlineWrapper, {
72
- ref: wrapperRef,
73
- slot: "tablist-wrapper",
74
- "data-icons-visible": iconsVisible,
75
- className: clsx(className, UnderlinePanels_module_css_default.StyledUnderlineWrapper),
76
- ...props,
77
- children: /*#__PURE__*/ jsx(UnderlineItemList, {
78
- ref: listRef,
79
- "aria-label": ariaLabel,
80
- "aria-labelledby": ariaLabelledBy,
81
- role: "tablist",
82
- children: tabs
83
- })
84
- }), tabPanels] })
88
+ children: /*#__PURE__*/ jsxs(Tabs, {
89
+ id: parentId,
90
+ value: selectedValue,
91
+ onValueChange: ({ value }) => setSelectedValue(value),
92
+ children: [/*#__PURE__*/ jsx(UnderlineWrapper, {
93
+ ref: wrapperRef,
94
+ "data-icons-visible": iconsVisible,
95
+ className: clsx(className, UnderlinePanels_module_css_default.StyledUnderlineWrapper),
96
+ ...props,
97
+ children: /*#__PURE__*/ jsx(UnderlineItemList, {
98
+ ref: listRef,
99
+ role: tabListProps.role,
100
+ "aria-label": tabListProps["aria-label"],
101
+ "aria-labelledby": tabListProps["aria-labelledby"],
102
+ "aria-orientation": tabListProps["aria-orientation"],
103
+ onKeyDown: tabListProps.onKeyDown,
104
+ children: tabs
105
+ })
106
+ }), tabPanels]
107
+ })
85
108
  });
86
109
  };
87
110
  UnderlinePanels.displayName = "UnderlinePanels";
88
- const TabImpl = ({ "aria-selected": ariaSelected, onSelect, ...props }) => {
111
+ const TabImpl = ({ onSelect, value, ...itemProps }) => {
89
112
  const { loadingCounters } = useContext(UnderlinePanelsContext);
90
- const clickHandler = React.useCallback((event) => {
91
- if (!event.defaultPrevented && typeof onSelect === "function") onSelect(event);
92
- }, [onSelect]);
93
- const keyDownHandler = React.useCallback((event) => {
94
- if ((event.key === " " || event.key === "Enter") && !event.defaultPrevented && typeof onSelect === "function") onSelect(event);
95
- }, [onSelect]);
113
+ const { tabProps } = useTab({ value: value !== null && value !== void 0 ? value : "" });
114
+ const { onKeyDown: tabOnKeyDown, onMouseDown: tabOnMouseDown, onFocus: tabOnFocus, ...restTabProps } = tabProps;
96
115
  return /*#__PURE__*/ jsx(UnderlineItem, {
97
116
  as: "button",
98
- role: "tab",
99
- tabIndex: ariaSelected ? 0 : -1,
100
- "aria-selected": ariaSelected,
117
+ ...itemProps,
118
+ ...restTabProps,
101
119
  type: "button",
102
- onClick: clickHandler,
103
- onKeyDown: keyDownHandler,
104
- loadingCounters,
105
- ...props
120
+ onClick: (event) => {
121
+ if (!event.defaultPrevented && typeof onSelect === "function") onSelect(event);
122
+ },
123
+ onKeyDown: (event) => {
124
+ tabOnKeyDown === null || tabOnKeyDown === void 0 || tabOnKeyDown(event);
125
+ if ((event.key === " " || event.key === "Enter") && !event.defaultPrevented && typeof onSelect === "function") onSelect(event);
126
+ },
127
+ onMouseDown: tabOnMouseDown,
128
+ onFocus: tabOnFocus,
129
+ loadingCounters
106
130
  });
107
131
  };
108
132
  TabImpl.displayName = "TabImpl";
109
133
  TabImpl.displayName = "UnderlinePanels.Tab";
110
134
  const Tab = /*#__PURE__*/ React.memo(TabImpl);
111
135
  Tab.displayName = "UnderlinePanels.Tab";
112
- const Panel = ({ children, ...rest }) => {
136
+ const PanelImpl = ({ children, value, ...panelRest }) => {
137
+ const { tabPanelProps } = useTabPanel({ value: value !== null && value !== void 0 ? value : "" });
113
138
  return /*#__PURE__*/ jsx("div", {
114
- role: "tabpanel",
115
- ...rest,
139
+ ...panelRest,
140
+ ...tabPanelProps,
116
141
  children
117
142
  });
118
143
  };
119
- Panel.displayName = "Panel";
144
+ PanelImpl.displayName = "PanelImpl";
145
+ PanelImpl.displayName = "UnderlinePanels.Panel";
146
+ const Panel = PanelImpl;
120
147
  Panel.displayName = "UnderlinePanels.Panel";
121
148
  var UnderlinePanels_default = Object.assign(UnderlinePanels, {
122
149
  Panel,
@@ -4,15 +4,15 @@ import { Announce } from "../live-region/Announce.js";
4
4
  import { AriaAlert } from "../live-region/AriaAlert.js";
5
5
  import { AriaStatus } from "../live-region/AriaStatus.js";
6
6
  import { ButtonBase } from "../Button/ButtonBase.js";
7
+ import { DefaultFeatureFlags } from "../FeatureFlags/DefaultFeatureFlags.js";
8
+ import { FeatureFlags } from "../FeatureFlags/FeatureFlags.js";
9
+ import { useFeatureFlag } from "../FeatureFlags/useFeatureFlag.js";
7
10
  import { KeybindingHint } from "../KeybindingHint/KeybindingHint.js";
8
11
  import { getAccessibleKeybindingHintString } from "../KeybindingHint/utils.js";
9
12
  import { Tooltip } from "../TooltipV2/Tooltip.js";
10
13
  import { useOverflow } from "../hooks/useOverflow.js";
11
14
  import { ScrollableRegion } from "../ScrollableRegion/ScrollableRegion.js";
12
15
  import { Dialog } from "../Dialog/Dialog.js";
13
- import { DefaultFeatureFlags } from "../FeatureFlags/DefaultFeatureFlags.js";
14
- import { FeatureFlags } from "../FeatureFlags/FeatureFlags.js";
15
- import { useFeatureFlag } from "../FeatureFlags/useFeatureFlag.js";
16
16
  import { Stack } from "../Stack/index.js";
17
17
  import { SkeletonBox } from "../Skeleton/SkeletonBox.js";
18
18
  import { FilteredActionListLoadingTypes } from "../FilteredActionList/constants.js";
@@ -30,12 +30,12 @@ import { Table } from "../DataTable/index.js";
30
30
  import { InlineMessage } from "../InlineMessage/InlineMessage.js";
31
31
  import { Hidden } from "../Hidden/Hidden.js";
32
32
  import { SelectPanel } from "./SelectPanel2/SelectPanel.js";
33
- import UnderlinePanels_default from "./UnderlinePanels/UnderlinePanels.js";
34
- import { IssueLabel } from "./IssueLabel/IssueLabel.js";
35
33
  import { useTab } from "./Tabs/useTab.js";
36
34
  import { useTabList } from "./Tabs/useTabList.js";
37
35
  import { useTabPanel } from "./Tabs/useTabPanel.js";
38
36
  import { Tabs } from "./Tabs/Tabs.js";
37
+ import UnderlinePanels_default from "./UnderlinePanels/UnderlinePanels.js";
38
+ import { IssueLabel } from "./IssueLabel/IssueLabel.js";
39
39
  import { TopicTag } from "../TopicTag/index.js";
40
40
  //#region src/experimental/index.ts
41
41
  /**
@@ -17,18 +17,18 @@ import { ForwardedRef, Ref } from "react";
17
17
  * // React 18
18
18
  * const Example = forwardRef<HTMLButtonElement, {}>((props, forwardedRef) => {
19
19
  * const ref = useRef<HTMLButtonElement>(null)
20
- * const combinedRef = useMergedRefs(forwardedRef, ref)
20
+ * const mergedRef = useMergedRefs(forwardedRef, ref)
21
21
  *
22
- * return <button ref={combinedRef} />
22
+ * return <button ref={mergedRef} />
23
23
  * })
24
24
  *
25
25
  * @example
26
26
  * // React 19
27
27
  * const Example = ({ref: externalRef}: {ref?: Ref<HTMLButtonElement>}) => {
28
28
  * const ref = useRef<HTMLButtonElement>(null)
29
- * const combinedRef = useMergedRefs(externalRef, ref)
29
+ * const mergedRef = useMergedRefs(externalRef, ref)
30
30
  *
31
- * return <button ref={combinedRef} />
31
+ * return <button ref={mergedRef} />
32
32
  * }
33
33
  */
34
34
  declare function useMergedRefs<T>(refA: Ref$1<T | null>, refB: Ref$1<T | null>): (value: T | null) => (() => void) | undefined;
@@ -1,7 +1,9 @@
1
1
  import { isExperimentalReactVersion, reactMajorVersion } from "../utils/environment.js";
2
2
  import { c } from "react-compiler-runtime";
3
- import "react";
3
+ import { version } from "react";
4
4
  //#region src/hooks/useMergedRefs.ts
5
+ var _version$split$;
6
+ const majorReactVersion = parseInt((_version$split$ = version.split(".")[0]) !== null && _version$split$ !== void 0 ? _version$split$ : "18", 10);
5
7
  /**
6
8
  * Cleanup functions for refs were introduced in React 19. For feature detection,
7
9
  * we look to see if current version of React is >= 19 or if it is an
@@ -26,18 +28,18 @@ const supportsRefCleanup = reactMajorVersion >= 19 || isExperimentalReactVersion
26
28
  * // React 18
27
29
  * const Example = forwardRef<HTMLButtonElement, {}>((props, forwardedRef) => {
28
30
  * const ref = useRef<HTMLButtonElement>(null)
29
- * const combinedRef = useMergedRefs(forwardedRef, ref)
31
+ * const mergedRef = useMergedRefs(forwardedRef, ref)
30
32
  *
31
- * return <button ref={combinedRef} />
33
+ * return <button ref={mergedRef} />
32
34
  * })
33
35
  *
34
36
  * @example
35
37
  * // React 19
36
38
  * const Example = ({ref: externalRef}: {ref?: Ref<HTMLButtonElement>}) => {
37
39
  * const ref = useRef<HTMLButtonElement>(null)
38
- * const combinedRef = useMergedRefs(externalRef, ref)
40
+ * const mergedRef = useMergedRefs(externalRef, ref)
39
41
  *
40
- * return <button ref={combinedRef} />
42
+ * return <button ref={mergedRef} />
41
43
  * }
42
44
  */
43
45
  function useMergedRefs(refA, refB) {
@@ -48,6 +50,7 @@ function useMergedRefs(refA, refB) {
48
50
  const cleanupA = setRef(refA, value);
49
51
  const cleanupB = setRef(refB, value);
50
52
  if (!supportsRefCleanup) return;
53
+ if (majorReactVersion <= 18) return;
51
54
  return () => {
52
55
  if (cleanupA) cleanupA();
53
56
  else setRef(refA, null);
@@ -9,17 +9,14 @@ import React from "react";
9
9
  * @param providedRef The ref to use - if undefined, will use the ref from a call to React.useRef
10
10
  * @type TRef The type of the RefObject which should be created.
11
11
  *
12
- * @deprecated This hook is incompatible with forwarded callback refs. Prefer `useMergedRefs` with an internally
13
- * created ref instead.
12
+ * @note This hook is overly restrictive in that it forces the provided ref to be a ref object rather than a callback.
13
+ * In particular, it should **not** be used to merge internal refs with forwarded refs. For this, use
14
+ * {@linkcode useMergedRefs} instead.
14
15
  *
15
- * ```diff
16
- * - const ref = useProvidedRefOrCreate(forwardedRef as RefObject<...>)
17
- * + const ref = useRef(null)
18
- * + const mergedRef = useMergedRefs(forwardedRef, ref)
19
- *
20
- * - return <div ref={ref} />
21
- * + return <div ref={mergedRef} />
22
- * ```
16
+ * The primary valid use case for this hook is for when the consumer is using the provided ref to point to an external
17
+ * element, like an externally rendered anchor. This is 'backwards' from forwarded refs with respect to data flow; the
18
+ * consumer is passing a reference to an external element, rather than passing a handle to obtain a reference to an
19
+ * internal element.
23
20
  */
24
21
  declare function useProvidedRefOrCreate<TRef>(providedRef?: React.RefObject<TRef | null>): React.RefObject<TRef | null>;
25
22
  //#endregion
@@ -8,17 +8,14 @@ import React from "react";
8
8
  * @param providedRef The ref to use - if undefined, will use the ref from a call to React.useRef
9
9
  * @type TRef The type of the RefObject which should be created.
10
10
  *
11
- * @deprecated This hook is incompatible with forwarded callback refs. Prefer `useMergedRefs` with an internally
12
- * created ref instead.
11
+ * @note This hook is overly restrictive in that it forces the provided ref to be a ref object rather than a callback.
12
+ * In particular, it should **not** be used to merge internal refs with forwarded refs. For this, use
13
+ * {@linkcode useMergedRefs} instead.
13
14
  *
14
- * ```diff
15
- * - const ref = useProvidedRefOrCreate(forwardedRef as RefObject<...>)
16
- * + const ref = useRef(null)
17
- * + const mergedRef = useMergedRefs(forwardedRef, ref)
18
- *
19
- * - return <div ref={ref} />
20
- * + return <div ref={mergedRef} />
21
- * ```
15
+ * The primary valid use case for this hook is for when the consumer is using the provided ref to point to an external
16
+ * element, like an externally rendered anchor. This is 'backwards' from forwarded refs with respect to data flow; the
17
+ * consumer is passing a reference to an external element, rather than passing a handle to obtain a reference to an
18
+ * internal element.
22
19
  */
23
20
  function useProvidedRefOrCreate(providedRef) {
24
21
  const createdRef = React.useRef(null);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@primer/react",
3
3
  "type": "module",
4
- "version": "38.34.0-rc.f86dc8614",
4
+ "version": "38.34.0",
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",
@@ -77,7 +77,6 @@
77
77
  "dependencies": {
78
78
  "@github/mini-throttle": "^2.1.1",
79
79
  "@github/relative-time-element": "^5.0.0",
80
- "@github/tab-container-element": "^4.8.2",
81
80
  "@lit-labs/react": "1.2.1",
82
81
  "@oddbird/popover-polyfill": "^0.5.2",
83
82
  "@primer/behaviors": "^1.10.3",