@ariakit/react-core 0.1.8 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,101 @@
 # @ariakit/react-core
 
+## 0.2.0
+
+### Minor Changes
+
+- **BREAKING**: Moved props from the `usePopoverStore` hook to the `Popover` component: `fixed`, `gutter`, `shift`, `flip`, `slide`, `overlap`, `sameWidth`, `fitViewport`, `arrowPadding`, `overflowPadding`, `getAnchorRect`, `renderCallback` (renamed to `updatePosition`). ([#2279](https://github.com/ariakit/ariakit/pull/2279))
+
+  The exception is the `placement` prop that should still be passed to the store.
+
+  **Before**:
+
+  ```jsx
+  const popover = usePopoverStore({
+    placement: "bottom",
+    fixed: true,
+    gutter: 8,
+    shift: 8,
+    flip: true,
+    slide: true,
+    overlap: true,
+    sameWidth: true,
+    fitViewport: true,
+    arrowPadding: 8,
+    overflowPadding: 8,
+    getAnchorRect: (anchor) => anchor?.getBoundingClientRect(),
+    renderCallback: (props) => props.defaultRenderCallback(),
+  });
+
+  <Popover store={popover} />;
+  ```
+
+  **After**:
+
+  ```jsx
+  const popover = usePopoverStore({ placement: "bottom" });
+
+  <Popover
+    store={popover}
+    fixed
+    gutter={8}
+    shift={8}
+    flip
+    slide
+    overlap
+    sameWidth
+    fitViewport
+    arrowPadding={8}
+    overflowPadding={8}
+    getAnchorRect={(anchor) => anchor?.getBoundingClientRect()}
+    updatePosition={(props) => props.updatePosition()}
+  />;
+  ```
+
+  This change affects all the hooks and components that use `usePopoverStore` and `Popover` underneath: `useComboboxStore`, `ComboboxPopover`, `useHovercardStore`, `Hovercard`, `useMenuStore`, `Menu`, `useSelectStore`, `SelectPopover`, `useTooltipStore`, `Tooltip`.
+
+  With this change, the underlying `@floating-ui/dom` dependency has been also moved to the `Popover` component, which means it can be lazy loaded. See the [Lazy Popover](https://ariakit.org/examples/popover-lazy) example.
+
+- **BREAKING**: The backdrop element on the `Dialog` component is now rendered as a sibling rather than as a parent of the dialog. This should make it easier to animate them separately. ([#2407](https://github.com/ariakit/ariakit/pull/2407))
+
+  This might be a breaking change if you're relying on their parent/child relationship for styling purposes (for example, to position the dialog in the center of the backdrop). If that's the case, you can apply the following styles to the dialog to achieve the same effect:
+
+  ```css
+  .dialog {
+    position: fixed;
+    inset: 1rem;
+    margin: auto;
+    height: fit-content;
+    max-height: calc(100vh - 2 * 1rem);
+  }
+  ```
+
+  These styles work even if the dialog is a child of the backdrop, so you can use them regardless of whether you're upgrading to this version or not.
+
+### Patch Changes
+
+- Deprecated the `backdropProps` prop on the `Dialog` component. Use the `backdrop` prop instead. ([#2407](https://github.com/ariakit/ariakit/pull/2407))
+
+- The `backdrop` prop on the `Dialog` component now accepts a JSX element as its value. ([#2407](https://github.com/ariakit/ariakit/pull/2407))
+
+- The `Dialog` component will now wait for being unmounted before restoring the body scroll when the `hidden` prop is set to `false`. This should prevent the body scroll from being restored too early when the dialog is being animated out using third-party libraries like Framer Motion. ([#2407](https://github.com/ariakit/ariakit/pull/2407))
+
+- The `Tooltip` component now defaults to use `aria-describedby` instead of `aria-labelledby`. ([#2279](https://github.com/ariakit/ariakit/pull/2279))
+
+  If you want to use the tooltip as a label for an anchor element, you can use the `type` prop on `useTooltipStore`:
+
+  ```jsx
+  useTooltipStore({ type: "label" });
+  ```
+
+- The `Tooltip` component now supports mouse events. ([#2279](https://github.com/ariakit/ariakit/pull/2279))
+
+  It's now possible to hover over the tooltip without it disappearing, which makes it compliant with [WCAG 1.4.13](https://www.w3.org/WAI/WCAG21/Understanding/content-on-hover-or-focus.html).
+
+- Fixed infinite loop on `Portal` with the `preserveTabOrder` prop set to `true` when the portalled element is placed right after its original position in the React tree. ([#2279](https://github.com/ariakit/ariakit/pull/2279))
+
+- Updated dependencies: `@ariakit/core@0.2.0`.
+
 ## 0.1.8
 
 ### Patch Changes

package/cjs/__chunks/{XFZ3MEQZ.cjs → 27JG67F3.cjs}

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } }
 
 
-var _AUDANYMJcjs = require('./AUDANYMJ.cjs');
+var _W2XKIB23cjs = require('./W2XKIB23.cjs');
 
 
 var _F7HVNVHQcjs = require('./F7HVNVHQ.cjs');
@@ -12,10 +12,10 @@ var _6455U47Tcjs = require('./6455U47T.cjs');
 // src/hovercard/hovercard-store.ts
 var _hovercardstore = require('@ariakit/core/hovercard/hovercard-store'); var Core = _interopRequireWildcard(_hovercardstore);
 function useHovercardStoreOptions(props) {
-  return _AUDANYMJcjs.usePopoverStoreOptions.call(void 0, props);
+  return _W2XKIB23cjs.usePopoverStoreOptions.call(void 0, props);
 }
 function useHovercardStoreProps(store, props) {
-  return _AUDANYMJcjs.usePopoverStoreProps.call(void 0, store, props);
+  return _W2XKIB23cjs.usePopoverStoreProps.call(void 0, store, props);
 }
 function useHovercardStore(props = {}) {
   const options = useHovercardStoreOptions(props);

package/cjs/__chunks/{ASQZCUUA.cjs → 4SZYU2PD.cjs}

@@ -6,7 +6,7 @@ var _HVQRVCAScjs = require('./HVQRVCAS.cjs');
 var _RCGSDYWJcjs = require('./RCGSDYWJ.cjs');
 
 
-var _5I6IQHKQcjs = require('./5I6IQHKQ.cjs');
+var _BIPONQXEcjs = require('./BIPONQXE.cjs');
 
 
 
@@ -101,7 +101,7 @@ var useSelectList = _7NAIPZYNcjs.createHook.call(void 0,
     const canFocusOnMove = store.useState(
       (state) => state.open && !state.animating && focusOnMove
     );
-    props = _5I6IQHKQcjs.useComposite.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {
+    props = _BIPONQXEcjs.useComposite.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {
       store
     }, props), {
       composite,

package/cjs/__chunks/5P6HRGY6.cjs

@@ -0,0 +1,21 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _7NAIPZYNcjs = require('./7NAIPZYN.cjs');
+
+// src/role/role.ts
+var useRole = _7NAIPZYNcjs.createHook.call(void 0, (props) => {
+  return props;
+});
+var Role = _7NAIPZYNcjs.createComponent.call(void 0, (props) => {
+  return _7NAIPZYNcjs.createElement.call(void 0, "div", props);
+});
+if (process.env.NODE_ENV !== "production") {
+  Role.displayName = "Role";
+}
+
+
+
+
+exports.useRole = useRole; exports.Role = Role;

package/cjs/__chunks/{YYKQBWQQ.cjs → A6ZSQXNQ.cjs}

@@ -5,7 +5,7 @@
 var _OLGMV24Ucjs = require('./OLGMV24U.cjs');
 
 
-var _JZRGYPLKcjs = require('./JZRGYPLK.cjs');
+var _MHL3EECXcjs = require('./MHL3EECX.cjs');
 
 
 
@@ -282,7 +282,7 @@ var useHovercard = _7NAIPZYNcjs.createHook.call(void 0,
     });
     props = useAutoFocusOnHide(_6455U47Tcjs.__spreadValues.call(void 0, { store }, props));
     props = useAutoFocusOnShow(_6455U47Tcjs.__spreadValues.call(void 0, { store, modal }, props));
-    props = _JZRGYPLKcjs.usePopover.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {
+    props = _MHL3EECXcjs.usePopover.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {
       hideOnEscape,
       store,
       modal,

package/cjs/__chunks/{OMM6PC3A.cjs → D3EUPD6P.cjs}

@@ -3,6 +3,9 @@
 var _CARNFZQTcjs = require('./CARNFZQT.cjs');
 
 
+var _5P6HRGY6cjs = require('./5P6HRGY6.cjs');
+
+
 var _EM2PMFEWcjs = require('./EM2PMFEW.cjs');
 
 
@@ -21,8 +24,7 @@ function DialogBackdrop({
   store,
   backdrop,
   backdropProps,
-  hidden,
-  children
+  hidden
 }) {
   const ref = _react.useRef.call(void 0, null);
   store = _react.useMemo.call(void 0, 
@@ -52,11 +54,15 @@ function DialogBackdrop({
       return;
     return _CARNFZQTcjs.markAncestor.call(void 0, backdrop2, id);
   }, [contentElement]);
+  backdropProps = _react.isValidElement.call(void 0, backdrop) ? _6455U47Tcjs.__spreadValues.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {
+    ref: "ref" in backdrop ? backdrop.ref : void 0
+  }, backdrop.props), backdropProps) : backdropProps;
   const props = _EM2PMFEWcjs.useDisclosureContent.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {
     store,
     id: void 0,
     role: "presentation",
-    hidden
+    hidden,
+    "data-backdrop": (contentElement == null ? void 0 : contentElement.id) || ""
   }, backdropProps), {
     ref: _NREUHWTUcjs.useForkRef.call(void 0, backdropProps == null ? void 0 : backdropProps.ref, ref),
     style: _6455U47Tcjs.__spreadValues.call(void 0, {
@@ -67,8 +73,13 @@ function DialogBackdrop({
       left: 0
     }, backdropProps == null ? void 0 : backdropProps.style)
   }));
+  if (!backdrop)
+    return null;
+  if (_react.isValidElement.call(void 0, backdrop)) {
+    return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, _5P6HRGY6cjs.Role, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {}, props), { children: (props2) => _react.cloneElement.call(void 0, backdrop, props2) }));
+  }
   const Component = typeof backdrop !== "boolean" ? backdrop || "div" : "div";
-  return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, Component, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {}, props), { "data-backdrop": (contentElement == null ? void 0 : contentElement.id) || "", children }));
+  return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, _5P6HRGY6cjs.Role, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {}, props), { as: Component }));
 }
 
 

package/cjs/__chunks/{IRSBF3C5.cjs → GOXUG4RX.cjs}

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _OMM6PC3Acjs = require('./OMM6PC3A.cjs');
+var _D3EUPD6Pcjs = require('./D3EUPD6P.cjs');
 
 
 var _O45IXGJWcjs = require('./O45IXGJW.cjs');
@@ -30,18 +30,18 @@ var _GHWBKA6Hcjs = require('./GHWBKA6H.cjs');
 var _SOPRUU56cjs = require('./SOPRUU56.cjs');
 
 
+var _WWDX5YPGcjs = require('./WWDX5YPG.cjs');
 
 
-var _N2VCZZLPcjs = require('./N2VCZZLP.cjs');
 
 
-var _NVBNDB5Bcjs = require('./NVBNDB5B.cjs');
+var _N2VCZZLPcjs = require('./N2VCZZLP.cjs');
 
 
-var _PFD4TS6Bcjs = require('./PFD4TS6B.cjs');
+var _EM2PMFEWcjs = require('./EM2PMFEW.cjs');
 
 
-var _EM2PMFEWcjs = require('./EM2PMFEW.cjs');
+var _NVBNDB5Bcjs = require('./NVBNDB5B.cjs');
 
 
 
@@ -152,7 +152,11 @@ var useDialog = _7NAIPZYNcjs.createHook.call(void 0,
     const open = store.useState("open");
     const mounted = store.useState("mounted");
     const contentElement = store.useState("contentElement");
-    _QRAQT522cjs.usePreventBodyScroll.call(void 0, store, mounted && preventBodyScroll);
+    const hiddenProp = props.hidden;
+    _QRAQT522cjs.usePreventBodyScroll.call(void 0, 
+      store,
+      (mounted || hiddenProp === false) && preventBodyScroll
+    );
     _E5VOJWDRcjs.useHideOnInteractOutside.call(void 0, store, hideOnInteractOutside);
     const { wrapElement, nestedDialogs } = _NZYGNCZLcjs.useNestedDialogs.call(void 0, store);
     props = _NREUHWTUcjs.useWrapElement.call(void 0, props, wrapElement, [wrapElement]);
@@ -392,21 +396,22 @@ var useDialog = _7NAIPZYNcjs.createHook.call(void 0,
       (element) => /* @__PURE__ */ _jsxruntime.jsx.call(void 0, _SOPRUU56cjs.HeadingLevel, { level: modal ? 1 : void 0, children: element }),
       [modal]
     );
-    const hiddenProp = props.hidden;
     props = _NREUHWTUcjs.useWrapElement.call(void 0, 
       props,
       (element) => {
         if (backdrop) {
-          return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, 
-            _OMM6PC3Acjs.DialogBackdrop,
-            {
-              store,
-              backdrop,
-              backdropProps,
-              hidden: hiddenProp,
-              children: element
-            }
-          );
+          return /* @__PURE__ */ _jsxruntime.jsxs.call(void 0, _jsxruntime.Fragment, { children: [
+            backdrop && /* @__PURE__ */ _jsxruntime.jsx.call(void 0, 
+              _D3EUPD6Pcjs.DialogBackdrop,
+              {
+                store,
+                backdrop,
+                backdropProps,
+                hidden: hiddenProp
+              }
+            ),
+            element
+          ] });
         }
         return element;
       },
@@ -434,7 +439,7 @@ var useDialog = _7NAIPZYNcjs.createHook.call(void 0,
     }));
     props = _EM2PMFEWcjs.useDisclosureContent.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, { store }, props));
     props = _NVBNDB5Bcjs.useFocusable.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, {}, props), { focusable }));
-    props = _PFD4TS6Bcjs.usePortal.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, { portal }, props), { portalRef, preserveTabOrder }));
+    props = _WWDX5YPGcjs.usePortal.call(void 0, _6455U47Tcjs.__spreadProps.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, { portal }, props), { portalRef, preserveTabOrder }));
     return props;
   }
 );

package/cjs/__chunks/{RHO5OVPE.cjs → GRL5KGV3.cjs}

@@ -7,7 +7,7 @@ var _MPFAD3UKcjs = require('./MPFAD3UK.cjs');
 var _HVQRVCAScjs = require('./HVQRVCAS.cjs');
 
 
-var _5I6IQHKQcjs = require('./5I6IQHKQ.cjs');
+var _BIPONQXEcjs = require('./BIPONQXE.cjs');
 
 
 
@@ -145,7 +145,7 @@ var useMenuList = _7NAIPZYNcjs.createHook.call(void 0,
         "aria-orientation": orientation
       }, props);
     }
-    props = _5I6IQHKQcjs.useComposite.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, { store, composite }, props));
+    props = _BIPONQXEcjs.useComposite.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, { store, composite }, props));
     props = _HVQRVCAScjs.useCompositeTypeahead.call(void 0, _6455U47Tcjs.__spreadValues.call(void 0, { store }, props));
     return props;
   }