UNPKG

@wordpress/components

Version:
219 lines (218 loc) • 7.5 kB
"use strict"; Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } }); // \0rolldown/runtime.js var __create = Object.create; var __defProp = Object.defineProperty; var __getOwnPropDesc = Object.getOwnPropertyDescriptor; var __getOwnPropNames = Object.getOwnPropertyNames; var __getProtoOf = Object.getPrototypeOf; var __hasOwnProp = Object.prototype.hasOwnProperty; var __copyProps = (to, from, except, desc) => { if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) { key = keys[i]; if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, { get: ((k) => from[k]).bind(null, key), enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); } return to; }; var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod)); let _ariakit_react = require("@ariakit/react"); _ariakit_react = __toESM(_ariakit_react); let _wordpress_i18n = require("@wordpress/i18n"); let _wordpress_element = require("@wordpress/element"); let __context_tsx = require("./context.cjs"); let __group_tsx = require("./group.cjs"); let __group_label_tsx = require("./group-label.cjs"); let __hover_tsx = require("./hover.cjs"); let __item_tsx = require("./item.cjs"); let __row_tsx = require("./row.cjs"); let __typeahead_tsx = require("./typeahead.cjs"); let react_jsx_runtime = require("react/jsx-runtime"); // packages/components/src/composite/index.tsx /** * Composite is a component that may contain navigable items represented by * Composite.Item. 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. * * @see https://ariakit.org/components/composite */ /** * Renders a widget based on the WAI-ARIA [`composite`](https://w3c.github.io/aria/#composite) * role, which provides a single tab stop on the page and arrow key navigation * through the focusable descendants. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite> * <Composite.Item>Item 1</Composite.Item> * <Composite.Item>Item 2</Composite.Item> * </Composite> * ``` */ const Composite = Object.assign((0, _wordpress_element.forwardRef)(function UnforwardedComposite({ activeId, defaultActiveId, setActiveId, focusLoop = false, focusWrap = false, focusShift = false, virtualFocus = false, orientation = "both", rtl = (0, _wordpress_i18n.isRTL)(), children, disabled = false, ...props }, ref) { const storeProp = props.store; const internalStore = _ariakit_react.useCompositeStore({ activeId, defaultActiveId, setActiveId, focusLoop, focusWrap, focusShift, virtualFocus, orientation, rtl }); const store = storeProp ?? internalStore; const contextValue = (0, _wordpress_element.useMemo)(() => ({ store }), [store]); return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(_ariakit_react.Composite, { disabled, store, ...props, ref, children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__context_tsx.CompositeContext.Provider, { value: contextValue, children }) }); }), { /** * Renders a group element for composite items. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite> * <Composite.Group> * <Composite.GroupLabel>Label</Composite.GroupLabel> * <Composite.Item>Item 1</Composite.Item> * <Composite.Item>Item 2</Composite.Item> * </CompositeGroup> * </Composite> * ``` */ Group: Object.assign(__group_tsx.CompositeGroup, { displayName: "Composite.Group" }), /** * Renders a label in a composite group. This component must be wrapped with * `Composite.Group` so the `aria-labelledby` prop is properly set on the * composite group element. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite> * <Composite.Group> * <Composite.GroupLabel>Label</Composite.GroupLabel> * <Composite.Item>Item 1</Composite.Item> * <Composite.Item>Item 2</Composite.Item> * </CompositeGroup> * </Composite> * ``` */ GroupLabel: Object.assign(__group_label_tsx.CompositeGroupLabel, { displayName: "Composite.GroupLabel" }), /** * Renders a composite item. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite> * <Composite.Item>Item 1</Composite.Item> * <Composite.Item>Item 2</Composite.Item> * <Composite.Item>Item 3</Composite.Item> * </Composite> * ``` */ Item: Object.assign(__item_tsx.CompositeItem, { displayName: "Composite.Item" }), /** * Renders a composite row. Wrapping `Composite.Item` elements within * `Composite.Row` will create a two-dimensional composite widget, such as a * grid. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite> * <Composite.Row> * <Composite.Item>Item 1.1</Composite.Item> * <Composite.Item>Item 1.2</Composite.Item> * <Composite.Item>Item 1.3</Composite.Item> * </Composite.Row> * <Composite.Row> * <Composite.Item>Item 2.1</Composite.Item> * <Composite.Item>Item 2.2</Composite.Item> * <Composite.Item>Item 2.3</Composite.Item> * </Composite.Row> * </Composite> * ``` */ Row: Object.assign(__row_tsx.CompositeRow, { displayName: "Composite.Row" }), /** * Renders an element in a composite widget that receives focus on mouse move * and loses focus to the composite base element on mouse leave. This should * be combined with the `Composite.Item` component. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite> * <Composite.Hover render={ <Composite.Item /> }> * Item 1 * </Composite.Hover> * <Composite.Hover render={ <Composite.Item /> }> * Item 2 * </Composite.Hover> * </Composite> * ``` */ Hover: Object.assign(__hover_tsx.CompositeHover, { displayName: "Composite.Hover" }), /** * Renders a component that adds typeahead functionality to composite * components. Hitting printable character keys will move focus to the next * composite item that begins with the input characters. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * * <Composite render={ <CompositeTypeahead /> }> * <Composite.Item>Item 1</Composite.Item> * <Composite.Item>Item 2</Composite.Item> * </Composite> * ``` */ Typeahead: Object.assign(__typeahead_tsx.CompositeTypeahead, { displayName: "Composite.Typeahead" }), /** * The React context used by the composite components. It can be used by * to access the composite store, and to forward the context when composite * sub-components are rendered across portals (ie. `SlotFill` components) * that would not otherwise forward the context to the `Fill` children. * * @example * ```jsx * import { Composite } from '@wordpress/components'; * import { useContext } from '@wordpress/element'; * * const compositeContext = useContext( Composite.Context ); * ``` */ Context: Object.assign(__context_tsx.CompositeContext, { displayName: "Composite.Context" }) }); exports.Composite = Composite; //# sourceMappingURL=index.cjs.map