@deque/cauldron-react 7.5.0-canary.b12b7518 → 7.5.0-canary.cacd23dd

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 (2) hide show
  1. package/lib/index.js +63 -13
  2. package/package.json +2 -2
package/lib/index.js CHANGED
@@ -1886,6 +1886,12 @@ var preventTopOverflowMiddleware = {
1886
1886
  });
1887
1887
  }
1888
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 }); };
1889
1895
  var AnchoredOverlay = React.forwardRef(function (_a, refProp) {
1890
1896
  var _b, _c;
1891
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"]);
@@ -1914,8 +1920,35 @@ var AnchoredOverlay = React.forwardRef(function (_a, refProp) {
1914
1920
  elements: {
1915
1921
  reference: resolveElement(target)
1916
1922
  },
1917
- whileElementsMounted: dom.autoUpdate
1918
- }), 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]);
1919
1952
  useEscapeKey({
1920
1953
  active: open,
1921
1954
  capture: true,
@@ -3787,6 +3820,20 @@ var Listbox = React.forwardRef(function (_a, ref) {
3787
3820
  var listboxRef = useSharedRef(ref);
3788
3821
  var isControlled = typeof value !== 'undefined';
3789
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]);
3790
3837
  React.useLayoutEffect(function () {
3791
3838
  if (!isControlled && selectedOptions.length > 0) {
3792
3839
  return;
@@ -3928,7 +3975,7 @@ var Listbox = React.forwardRef(function (_a, ref) {
3928
3975
  var firstOption = !focusDisabledOptions
3929
3976
  ? options.find(function (option) { return !isDisabledOption(option); })
3930
3977
  : options[0];
3931
- if (firstOption) {
3978
+ if (firstOption && firstOption.element !== (activeOption === null || activeOption === void 0 ? void 0 : activeOption.element)) {
3932
3979
  setActiveOption(firstOption);
3933
3980
  }
3934
3981
  return;
@@ -3937,7 +3984,7 @@ var Listbox = React.forwardRef(function (_a, ref) {
3937
3984
  var lastOption = !focusDisabledOptions
3938
3985
  ? tslib.__spreadArray([], tslib.__read(options), false).reverse().find(function (option) { return !isDisabledOption(option); })
3939
3986
  : options[options.length - 1];
3940
- if (lastOption) {
3987
+ if (lastOption && lastOption.element !== (activeOption === null || activeOption === void 0 ? void 0 : activeOption.element)) {
3941
3988
  setActiveOption(lastOption);
3942
3989
  }
3943
3990
  return;
@@ -5158,21 +5205,24 @@ function useMnemonics(_a) {
5158
5205
 
5159
5206
  var ActionList = React.forwardRef(function (_a, ref) {
5160
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"]);
5161
- 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.
5162
5214
  var _c = tslib.__read(React.useState(), 2), activeOption = _c[0], setActiveOption = _c[1];
5163
- var handleActiveChange = React.useCallback(function (value) {
5164
- activeElement.current = value === null || value === void 0 ? void 0 : value.element;
5165
- setActiveOption(value);
5166
- }, []);
5167
5215
  var handleAction = React.useCallback(function (key, event) {
5168
5216
  if (typeof onAction === 'function') {
5169
5217
  onAction(key, event);
5170
5218
  }
5171
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.
5172
5224
  var handleMnemonicMatch = React.useCallback(function (element) {
5173
- setActiveOption(function (prev) {
5174
- return (prev === null || prev === void 0 ? void 0 : prev.element) === element ? prev : { element: element };
5175
- });
5225
+ setActiveOption({ element: element });
5176
5226
  }, []);
5177
5227
  var containerRef = useMnemonics({
5178
5228
  onMatch: handleMnemonicMatch,
@@ -5189,7 +5239,7 @@ var ActionList = React.forwardRef(function (_a, ref) {
5189
5239
  /* Listbox comes with an explicit role of "listbox", but we want to either
5190
5240
  * use the role from props, or default to the intrinsic role */
5191
5241
  // eslint-disable-next-line jsx-a11y/aria-role
5192
- 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" }),
5193
5243
  React__default["default"].createElement(ActionListProvider, { role: props.role || 'list', onAction: handleAction, selectionType: selectionType }, children)));
5194
5244
  });
5195
5245
  ActionList.displayName = 'ActionList';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deque/cauldron-react",
3
- "version": "7.5.0-canary.b12b7518",
3
+ "version": "7.5.0-canary.cacd23dd",
4
4
  "license": "MPL-2.0",
5
5
  "description": "Fully accessible react components library for Deque Cauldron",
6
6
  "homepage": "https://cauldron.dequelabs.com/",
@@ -37,7 +37,7 @@
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
42
  "@testing-library/user-event": "^14.5.2",
43
43
  "@types/classnames": "^2.2.10",