UNPKG

@wordpress/components

Version:
120 lines (119 loc) • 4.12 kB
import * as Ariakit from "@ariakit/react"; import { forwardRef } from "@wordpress/element"; import { useInstanceId } from "@wordpress/compose"; import deprecated from "@wordpress/deprecated"; import { Composite as Composite$1 } from "../index.mjs"; import { jsx } from "react/jsx-runtime"; // packages/components/src/composite/legacy/index.tsx /** * Composite is a component that may contain navigable items represented by * CompositeItem. It's inspired by the WAI-ARIA Composite Role and implements * all the keyboard navigation mechanisms to ensure that there's only one * tab stop for the whole Composite element. This means that it can behave as * a roving tabindex or aria-activedescendant container. * * This file aims at providing components that are as close as possible to the * original `reakit`-based implementation (which was removed from the codebase), * although it is recommended that consumers of the package switch to the stable, * un-prefixed, `ariakit`-based version of `Composite`. * * @see https://ariakit.org/components/composite */ function mapLegacyStatePropsToComponentProps(legacyProps) { if (legacyProps.state) { const { state, ...rest } = legacyProps; const { store, ...props } = mapLegacyStatePropsToComponentProps(state); return { ...rest, ...props, store }; } return legacyProps; } const LEGACY_TO_NEW_DISPLAY_NAME = { __unstableComposite: "Composite", __unstableCompositeGroup: "Composite.Group or Composite.Row", __unstableCompositeItem: "Composite.Item", __unstableUseCompositeState: "Composite" }; function proxyComposite(ProxiedComponent, propMap = {}) { const displayName = ProxiedComponent.displayName ?? ""; const Component = (legacyProps) => { deprecated(`wp.components.${displayName}`, { since: "6.7", alternative: LEGACY_TO_NEW_DISPLAY_NAME.hasOwnProperty(displayName) ? LEGACY_TO_NEW_DISPLAY_NAME[displayName] : void 0 }); const { store, ...rest } = mapLegacyStatePropsToComponentProps(legacyProps); let props = rest; props = { ...props, id: useInstanceId(store, props.baseId, props.id) }; Object.entries(propMap).forEach(([from, to]) => { if (props.hasOwnProperty(from)) { Object.assign(props, { [to]: props[from] }); delete props[from]; } }); delete props.baseId; return /* @__PURE__ */ jsx(ProxiedComponent, { ...props, store }); }; Component.displayName = displayName; return Component; } const UnproxiedCompositeGroup = forwardRef(({ role, ...props }, ref) => { const Component = role === "row" ? Composite$1.Row : Composite$1.Group; return /* @__PURE__ */ jsx(Component, { ref, role, ...props }); }); /** * _Note: please use the `Composite` component instead._ * * @deprecated */ const Composite = proxyComposite(Object.assign(Composite$1, { displayName: "__unstableComposite" }), { baseId: "id" }); /** * _Note: please use the `Composite.Row` or `Composite.Group` components instead._ * * @deprecated */ const CompositeGroup = proxyComposite(Object.assign(UnproxiedCompositeGroup, { displayName: "__unstableCompositeGroup" })); /** * _Note: please use the `Composite.Item` component instead._ * * @deprecated */ const CompositeItem = proxyComposite(Object.assign(Composite$1.Item, { displayName: "__unstableCompositeItem" }), { focusable: "accessibleWhenDisabled" }); /** * _Note: please use the `Composite` component instead._ * * @deprecated */ function useCompositeState(legacyStateOptions = {}) { deprecated(`wp.components.__unstableUseCompositeState`, { since: "6.7", alternative: LEGACY_TO_NEW_DISPLAY_NAME.__unstableUseCompositeState }); const { baseId, currentId: defaultActiveId, orientation, rtl = false, loop: focusLoop = false, wrap: focusWrap = false, shift: focusShift = false, unstable_virtual: virtualFocus } = legacyStateOptions; return { baseId: useInstanceId(Composite, "composite", baseId), store: Ariakit.useCompositeStore({ defaultActiveId, rtl, orientation, focusLoop, focusShift, focusWrap, virtualFocus }) }; } export { Composite, CompositeGroup, CompositeItem, useCompositeState }; //# sourceMappingURL=index.mjs.map