@deque/cauldron-react 7.5.0 → 7.6.0-canary.0419668f

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/lib/cauldron.css CHANGED
@@ -27,7 +27,6 @@
27
27
  }
28
28
 
29
29
  /* Dark Theme */
30
-
31
30
  .cauldron--theme-dark {
32
31
  --expandcollapse-trigger-color: var(--white);
33
32
  --expandcollapse-panel-color: var(--accent-light);
@@ -38,7 +37,6 @@
38
37
  animation: none !important;
39
38
  }
40
39
  }
41
-
42
40
  a.Button--primary,
43
41
  a.Button--secondary,
44
42
  a.Button--thin {
@@ -53,7 +51,6 @@ a.Button--secondary {
53
51
  a.Button--thin {
54
52
  padding: 0 var(--space-small);
55
53
  }
56
-
57
54
  .Icon {
58
55
  display: inline-block;
59
56
  vertical-align: middle;
@@ -66,7 +63,6 @@ a.Button--thin {
66
63
  }
67
64
 
68
65
  /* Icon--down is the default orientation */
69
-
70
66
  .Icon__down {
71
67
  }
72
68
 
@@ -2,7 +2,14 @@ import React from 'react';
2
2
  import { Cauldron } from '../../types';
3
3
  import { TreeViewNode } from './types';
4
4
  export type { TreeViewNode } from './types';
5
- type TreeViewProps = Cauldron.LabelProps & {
5
+ /** Seeds the initial scroll math. Keep in step with `--tree-view-row-height`,
6
+ * which sizes a virtualized row — see the spacing-parity test. */
7
+ export declare const ESTIMATED_ROW_HEIGHT = 36;
8
+ /** Keep in step with `--space-quarter` / `--space-half`, which `.TreeView` uses
9
+ * for its flex spacing — see the spacing-parity test. */
10
+ export declare const ROW_GAP = 2;
11
+ export declare const LIST_PADDING = 4;
12
+ type TreeViewProps = Cauldron.LabelProps & Omit<React.HTMLAttributes<HTMLDivElement>, 'children' | 'role' | 'dangerouslySetInnerHTML'> & {
6
13
  items: TreeViewNode[];
7
14
  onAction?: (key: string) => void;
8
15
  selectionMode?: 'none' | 'single' | 'multiple';
@@ -13,7 +20,15 @@ type TreeViewProps = Cauldron.LabelProps & {
13
20
  * all of its descendants. */
14
21
  cascadeDeselect?: boolean;
15
22
  defaultExpandedKeys?: string[];
16
- className?: string;
23
+ /** Render only the rows in view. Use for long lists, where rendering every
24
+ * row makes selection changes slow enough to look frozen. Needs a height —
25
+ * from `height`, `style`, or CSS — or no rows render. Toggling this at
26
+ * runtime remounts the tree, which resets expansion and scroll position. */
27
+ virtualized?: boolean;
28
+ /** Height of the scroll region, taking precedence over `style.height`. Only
29
+ * applies when `virtualized` is set. A relative unit (`"20rem"`) keeps the
30
+ * visible row count stable at zoom. */
31
+ height?: number | string;
17
32
  };
18
33
  declare const TreeView: React.ForwardRefExoticComponent<TreeViewProps & React.RefAttributes<HTMLDivElement>>;
19
34
  export default TreeView;
package/lib/index.js CHANGED
@@ -1659,7 +1659,11 @@ var DialogContent = function (_a) {
1659
1659
  'text--align-left': align === 'left',
1660
1660
  'text--align-center': align === 'center',
1661
1661
  'text--align-right': align === 'right'
1662
- }), tabIndex: (context === null || context === void 0 ? void 0 : context.scrollable) ? -1 : undefined }, other), children));
1662
+ }),
1663
+ // A keyboard user can only scroll this region if it is tabbable (WCAG
1664
+ // 2.1.1). The rule allows that on role="tabpanel" only. See #680.
1665
+ // eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex
1666
+ tabIndex: (context === null || context === void 0 ? void 0 : context.scrollable) ? 0 : undefined }, other), children));
1663
1667
  };
1664
1668
  DialogContent.displayName = 'DialogContent';
1665
1669
  var DialogFooter = function (_a) {
@@ -1882,6 +1886,12 @@ var preventTopOverflowMiddleware = {
1882
1886
  });
1883
1887
  }
1884
1888
  };
1889
+ // Element-resize tracking is split out of `whileElementsMounted` so it can be
1890
+ // scoped to the open state. This function's identity must stay stable:
1891
+ // floating-ui keys its positioning effect on whether one was passed, and a
1892
+ // re-run calls `update()` again, which on close pulls focus back out of the
1893
+ // trigger.
1894
+ var autoUpdateWithoutElementResize = function (reference, floating, update) { return dom.autoUpdate(reference, floating, update, { elementResize: false }); };
1885
1895
  var AnchoredOverlay = React.forwardRef(function (_a, refProp) {
1886
1896
  var _b, _c;
1887
1897
  var as = _a.as, _d = _a.placement, initialPlacement = _d === void 0 ? 'auto' : _d, target = _a.target, children = _a.children, style = _a.style, _e = _a.open, open = _e === void 0 ? false : _e, offset = _a.offset, focusTrap = _a.focusTrap, focusTrapOptions = _a.focusTrapOptions, onOpenChange = _a.onOpenChange, onPlacementChange = _a.onPlacementChange, onShiftChange = _a.onShiftChange, portal = _a.portal, props = tslib.__rest(_a, ["as", "placement", "target", "children", "style", "open", "offset", "focusTrap", "focusTrapOptions", "onOpenChange", "onPlacementChange", "onShiftChange", "portal"]);
@@ -1910,8 +1920,35 @@ var AnchoredOverlay = React.forwardRef(function (_a, refProp) {
1910
1920
  elements: {
1911
1921
  reference: resolveElement(target)
1912
1922
  },
1913
- whileElementsMounted: dom.autoUpdate
1914
- }), refs = _f.refs, floatingStyles = _f.floatingStyles, placement = _f.placement, middlewareData = _f.middlewareData;
1923
+ whileElementsMounted: autoUpdateWithoutElementResize
1924
+ }), refs = _f.refs, floatingStyles = _f.floatingStyles, placement = _f.placement, middlewareData = _f.middlewareData, update = _f.update, elements = _f.elements;
1925
+ // Observing the target while the overlay is closed measures it for the
1926
+ // first time mid-layout, which leaves a ResizeObserver notification
1927
+ // undelivered and has the browser report an uncaught error.
1928
+ React.useEffect(function () {
1929
+ var reference = elements.reference, floating = elements.floating;
1930
+ if (!open ||
1931
+ !reference ||
1932
+ !floating ||
1933
+ typeof ResizeObserver !== 'function') {
1934
+ return;
1935
+ }
1936
+ // Deferred a task: starting it re-positions, and a render in the middle
1937
+ // of the open sequence loses the overlay's initial focus target.
1938
+ var stopObserving;
1939
+ var timeout = setTimeout(function () {
1940
+ stopObserving = dom.autoUpdate(reference, floating, update, {
1941
+ ancestorScroll: false,
1942
+ ancestorResize: false,
1943
+ layoutShift: false,
1944
+ elementResize: true
1945
+ });
1946
+ });
1947
+ return function () {
1948
+ clearTimeout(timeout);
1949
+ stopObserving === null || stopObserving === void 0 ? void 0 : stopObserving();
1950
+ };
1951
+ }, [open, elements, update]);
1915
1952
  useEscapeKey({
1916
1953
  active: open,
1917
1954
  capture: true,
@@ -3783,6 +3820,20 @@ var Listbox = React.forwardRef(function (_a, ref) {
3783
3820
  var listboxRef = useSharedRef(ref);
3784
3821
  var isControlled = typeof value !== 'undefined';
3785
3822
  var isActiveControlled = typeof controlledActiveOption !== 'undefined';
3823
+ var hasActiveChangeHandler = typeof onActiveChange === 'function';
3824
+ React.useEffect(function () {
3825
+ if (process.env.NODE_ENV !== 'production' &&
3826
+ isActiveControlled &&
3827
+ hasActiveChangeHandler) {
3828
+ console.warn('Listbox received both `activeOption` and `onActiveChange`. Do not ' +
3829
+ 'write the option reported by `onActiveChange` back into ' +
3830
+ '`activeOption`: the two copies then race, and a stale downward ' +
3831
+ 'sync can revert a newer value and re-render without settling. ' +
3832
+ 'Let Listbox own the active option, or use `activeOption` only as ' +
3833
+ 'a one-shot request. ' +
3834
+ 'See https://github.com/dequelabs/cauldron/issues/2512');
3835
+ }
3836
+ }, [isActiveControlled, hasActiveChangeHandler]);
3786
3837
  React.useLayoutEffect(function () {
3787
3838
  if (!isControlled && selectedOptions.length > 0) {
3788
3839
  return;
@@ -3924,7 +3975,7 @@ var Listbox = React.forwardRef(function (_a, ref) {
3924
3975
  var firstOption = !focusDisabledOptions
3925
3976
  ? options.find(function (option) { return !isDisabledOption(option); })
3926
3977
  : options[0];
3927
- if (firstOption) {
3978
+ if (firstOption && firstOption.element !== (activeOption === null || activeOption === void 0 ? void 0 : activeOption.element)) {
3928
3979
  setActiveOption(firstOption);
3929
3980
  }
3930
3981
  return;
@@ -3933,7 +3984,7 @@ var Listbox = React.forwardRef(function (_a, ref) {
3933
3984
  var lastOption = !focusDisabledOptions
3934
3985
  ? tslib.__spreadArray([], tslib.__read(options), false).reverse().find(function (option) { return !isDisabledOption(option); })
3935
3986
  : options[options.length - 1];
3936
- if (lastOption) {
3987
+ if (lastOption && lastOption.element !== (activeOption === null || activeOption === void 0 ? void 0 : activeOption.element)) {
3937
3988
  setActiveOption(lastOption);
3938
3989
  }
3939
3990
  return;
@@ -5154,21 +5205,24 @@ function useMnemonics(_a) {
5154
5205
 
5155
5206
  var ActionList = React.forwardRef(function (_a, ref) {
5156
5207
  var _b = _a.selectionType, selectionType = _b === void 0 ? null : _b, onAction = _a.onAction, className = _a.className, children = _a.children, props = tslib.__rest(_a, ["selectionType", "onAction", "className", "children"]);
5157
- var activeElement = React.useRef(null);
5208
+ // Listbox owns the active option. ActionList must not mirror it back down
5209
+ // as a controlled prop: the two copies then race, and a downward sync
5210
+ // carrying an already-stale value can revert a newer one and oscillate.
5211
+ // `activeOption` below is only a one-shot mnemonic request, never a
5212
+ // mirror. See cauldron#2512; cauldron#2522 tracks making `activeOption`
5213
+ // properly controlled so this constraint lives in the interface instead.
5158
5214
  var _c = tslib.__read(React.useState(), 2), activeOption = _c[0], setActiveOption = _c[1];
5159
- var handleActiveChange = React.useCallback(function (value) {
5160
- activeElement.current = value === null || value === void 0 ? void 0 : value.element;
5161
- setActiveOption(value);
5162
- }, []);
5163
5215
  var handleAction = React.useCallback(function (key, event) {
5164
5216
  if (typeof onAction === 'function') {
5165
5217
  onAction(key, event);
5166
5218
  }
5167
5219
  }, [onAction]);
5220
+ // A new object every match, even for the same element: this is a one-shot
5221
+ // request to Listbox rather than a mirror of its state, so re-using the
5222
+ // previous object would leave the controlled prop unchanged and the
5223
+ // request would never reach Listbox.
5168
5224
  var handleMnemonicMatch = React.useCallback(function (element) {
5169
- setActiveOption(function (prev) {
5170
- return (prev === null || prev === void 0 ? void 0 : prev.element) === element ? prev : { element: element };
5171
- });
5225
+ setActiveOption({ element: element });
5172
5226
  }, []);
5173
5227
  var containerRef = useMnemonics({
5174
5228
  onMatch: handleMnemonicMatch,
@@ -5185,7 +5239,7 @@ var ActionList = React.forwardRef(function (_a, ref) {
5185
5239
  /* Listbox comes with an explicit role of "listbox", but we want to either
5186
5240
  * use the role from props, or default to the intrinsic role */
5187
5241
  // eslint-disable-next-line jsx-a11y/aria-role
5188
- role: undefined, "aria-multiselectable": undefined, className: classNames__default["default"]('ActionList', className), activeOption: activeOption }, props, { onActiveChange: handleActiveChange, navigation: "bound" }),
5242
+ role: undefined, "aria-multiselectable": undefined, className: classNames__default["default"]('ActionList', className), activeOption: activeOption }, props, { navigation: "bound" }),
5189
5243
  React__default["default"].createElement(ActionListProvider, { role: props.role || 'list', onAction: handleAction, selectionType: selectionType }, children)));
5190
5244
  });
5191
5245
  ActionList.displayName = 'ActionList';
@@ -5627,9 +5681,16 @@ function applyCascade(nodes, previous, next, selectionMode, _a) {
5627
5681
  return result;
5628
5682
  }
5629
5683
 
5684
+ /** Seeds the initial scroll math. Keep in step with `--tree-view-row-height`,
5685
+ * which sizes a virtualized row — see the spacing-parity test. */
5686
+ var ESTIMATED_ROW_HEIGHT = 36;
5687
+ /** Keep in step with `--space-quarter` / `--space-half`, which `.TreeView` uses
5688
+ * for its flex spacing — see the spacing-parity test. */
5689
+ var ROW_GAP = 2;
5690
+ var LIST_PADDING = 4;
5630
5691
  var TreeView = React.forwardRef(function (_a, ref) {
5631
- var items = _a.items, onAction = _a.onAction, _b = _a.selectionMode, selectionMode = _b === void 0 ? 'none' : _b, _c = _a.cascadeSelect, cascadeSelect = _c === void 0 ? false : _c, _d = _a.cascadeDeselect, cascadeDeselect = _d === void 0 ? false : _d, defaultExpandedKeys = _a.defaultExpandedKeys, className = _a.className, other = tslib.__rest(_a, ["items", "onAction", "selectionMode", "cascadeSelect", "cascadeDeselect", "defaultExpandedKeys", "className"]);
5632
- var _e = tslib.__read(React.useState(new Set()), 2), selectedKeys = _e[0], setSelectedKeys = _e[1];
5692
+ var items = _a.items, onAction = _a.onAction, _b = _a.selectionMode, selectionMode = _b === void 0 ? 'none' : _b, _c = _a.cascadeSelect, cascadeSelect = _c === void 0 ? false : _c, _d = _a.cascadeDeselect, cascadeDeselect = _d === void 0 ? false : _d, defaultExpandedKeys = _a.defaultExpandedKeys, _e = _a.virtualized, virtualized = _e === void 0 ? false : _e, height = _a.height, className = _a.className, style = _a.style, other = tslib.__rest(_a, ["items", "onAction", "selectionMode", "cascadeSelect", "cascadeDeselect", "defaultExpandedKeys", "virtualized", "height", "className", "style"]);
5693
+ var _f = tslib.__read(React.useState(new Set()), 2), selectedKeys = _f[0], setSelectedKeys = _f[1];
5633
5694
  var cascade = { cascadeSelect: cascadeSelect, cascadeDeselect: cascadeDeselect };
5634
5695
  // Cascade only applies to multiple selection.
5635
5696
  var isCascade = selectionMode === 'multiple' && (cascadeSelect || cascadeDeselect);
@@ -5655,12 +5716,28 @@ var TreeView = React.forwardRef(function (_a, ref) {
5655
5716
  };
5656
5717
  // Disabled nodes are non-selectable; react-aria disables them via disabledKeys.
5657
5718
  var disabledKeys = React.useMemo(function () { return collectDisabledKeys(items); }, [items]);
5658
- // Cascade requires controlling selection. Without it, preserve the original
5659
- // behavior: selection is only controlled when an `onAction` handler is set.
5660
- var selectionProps = selectionMode !== 'none' && (isCascade || onAction)
5719
+ // Always control selection: react-aria's own state is lost if the tree
5720
+ // remounts (which toggling `virtualized` does), taking the user's checkboxes
5721
+ // with it.
5722
+ var selectionProps = selectionMode !== 'none'
5661
5723
  ? { selectedKeys: selectedKeys, onSelectionChange: handleSelectionChange }
5662
5724
  : {};
5663
- return (React__default["default"].createElement(reactAriaComponents.Tree, tslib.__assign({ ref: ref, className: classNames__default["default"]('TreeView', className), selectionMode: selectionMode, defaultExpandedKeys: defaultExpandedKeys }, (disabledKeys.length > 0 ? { disabledKeys: disabledKeys } : {}), (onAction ? { onAction: handleAction } : {}), selectionProps, other), items.map(function (item) { return (React__default["default"].createElement(TreeViewItem, tslib.__assign({ key: item.id }, item))); })));
5725
+ // The `height` prop outranks `style.height`, but only when it is actually
5726
+ // set — spreading an undefined `height` would wipe the caller's own.
5727
+ var mergedStyle = virtualized && height !== undefined ? tslib.__assign(tslib.__assign({}, style), { height: height }) : style;
5728
+ var tree = (React__default["default"].createElement(reactAriaComponents.Tree, tslib.__assign({ ref: ref, className: classNames__default["default"]('TreeView', className, {
5729
+ 'TreeView--virtualized': virtualized
5730
+ }), selectionMode: selectionMode, defaultExpandedKeys: defaultExpandedKeys }, (disabledKeys.length > 0 ? { disabledKeys: disabledKeys } : {}), (onAction ? { onAction: handleAction } : {}), selectionProps, other, { style: mergedStyle }), items.map(function (item) { return (React__default["default"].createElement(TreeViewItem, tslib.__assign({ key: item.id }, item))); })));
5731
+ // Rows are absolutely positioned here, so the list layout owns their spacing
5732
+ // rather than `.TreeView`'s flex `gap`/`padding`.
5733
+ if (virtualized) {
5734
+ return (React__default["default"].createElement(reactAriaComponents.Virtualizer, { layout: reactAriaComponents.ListLayout, layoutOptions: {
5735
+ estimatedRowHeight: ESTIMATED_ROW_HEIGHT,
5736
+ gap: ROW_GAP,
5737
+ padding: LIST_PADDING
5738
+ } }, tree));
5739
+ }
5740
+ return tree;
5664
5741
  });
5665
5742
  TreeView.displayName = 'TreeView';
5666
5743
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deque/cauldron-react",
3
- "version": "7.5.0",
3
+ "version": "7.6.0-canary.0419668f",
4
4
  "license": "MPL-2.0",
5
5
  "description": "Fully accessible react components library for Deque Cauldron",
6
6
  "homepage": "https://cauldron.dequelabs.com/",
@@ -14,12 +14,12 @@
14
14
  "lib/"
15
15
  ],
16
16
  "dependencies": {
17
- "@floating-ui/dom": "^1.0.0",
17
+ "@floating-ui/dom": "^1.8.0",
18
18
  "@floating-ui/react-dom": "^2.1.2",
19
19
  "classnames": "^2.2.6",
20
20
  "focusable": "^2.3.0",
21
21
  "keyname": "^0.1.0",
22
- "react-aria-components": "^1.13.0",
22
+ "react-aria-components": "^1.20.0",
23
23
  "react-id-generator": "^3.0.1",
24
24
  "react-syntax-highlighter": "^16.1.1",
25
25
  "tslib": "^2.4.0"
@@ -37,9 +37,9 @@
37
37
  "@rollup/plugin-typescript": "^11.1.2",
38
38
  "@svgr/rollup": "^6.1.2",
39
39
  "@testing-library/dom": "^10.4.0",
40
- "@testing-library/jest-dom": "^6.6.2",
40
+ "@testing-library/jest-dom": "^7.0.0",
41
41
  "@testing-library/react": "^16.0.1",
42
- "@testing-library/user-event": "^14.5.2",
42
+ "@testing-library/user-event": "^14.6.7",
43
43
  "@types/classnames": "^2.2.10",
44
44
  "@types/jest": "^29.5.11",
45
45
  "@types/jest-axe": "^3.5.4",
@@ -56,7 +56,7 @@
56
56
  "jest-axe": "^10.0.0",
57
57
  "jest-environment-jsdom": "^29.7.0",
58
58
  "nyc": "^15.0.1",
59
- "postcss": "^8.5.15",
59
+ "postcss": "^8.5.28",
60
60
  "postcss-cli": "^11.0.1",
61
61
  "postcss-import": "^16.1.1",
62
62
  "postcss-loader": "^8.2.1",