@wordpress/components 28.6.0 → 28.7.0

package/src/composite/hover.tsx

@@ -0,0 +1,30 @@
+/**
+ * External dependencies
+ */
+import * as Ariakit from '@ariakit/react';
+
+/**
+ * WordPress dependencies
+ */
+import { forwardRef } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import type { WordPressComponentProps } from '../context';
+import { useCompositeContext } from './context';
+import type { CompositeHoverProps } from './types';
+
+export const CompositeHover = forwardRef<
+	HTMLDivElement,
+	WordPressComponentProps< CompositeHoverProps, 'div', false >
+>( function CompositeHover( props, ref ) {
+	const context = useCompositeContext();
+	return (
+		<Ariakit.CompositeHover
+			store={ context?.store }
+			{ ...props }
+			ref={ ref }
+		/>
+	);
+} );

package/src/composite/index.tsx

@@ -22,142 +22,14 @@ import { useMemo, forwardRef } from '@wordpress/element';
  * Internal dependencies
  */
 import type { WordPressComponentProps } from '../context';
-import { CompositeContext, useCompositeContext } from './context';
-import type {
-	CompositeStoreProps,
-	CompositeProps,
-	CompositeGroupProps,
-	CompositeGroupLabelProps,
-	CompositeItemProps,
-	CompositeRowProps,
-	CompositeHoverProps,
-	CompositeTypeaheadProps,
-} from './types';
-
-/**
- * Creates a composite store.
- *
- * @example
- * ```jsx
- * import { Composite, useCompositeStore } from '@wordpress/components';
- *
- * const store = useCompositeStore();
- * <Composite store={store}>
- *   <Composite.Item>Item</Composite.Item>
- *   <Composite.Item>Item</Composite.Item>
- *   <Composite.Item>Item</Composite.Item>
- * </Composite>
- * ```
- */
-export function useCompositeStore( {
-	focusLoop = false,
-	focusWrap = false,
-	focusShift = false,
-	virtualFocus = false,
-	orientation = 'both',
-	rtl = false,
-	...props
-}: CompositeStoreProps = {} ) {
-	return Ariakit.useCompositeStore( {
-		focusLoop,
-		focusWrap,
-		focusShift,
-		virtualFocus,
-		orientation,
-		rtl,
-		...props,
-	} );
-}
-
-const Group = forwardRef<
-	HTMLDivElement,
-	WordPressComponentProps< CompositeGroupProps, 'div', false >
->( function CompositeGroup( props, ref ) {
-	const context = useCompositeContext();
-	return (
-		<Ariakit.CompositeGroup
-			store={ context?.store }
-			{ ...props }
-			ref={ ref }
-		/>
-	);
-} );
-Group.displayName = 'Composite.Group';
-
-const GroupLabel = forwardRef<
-	HTMLDivElement,
-	WordPressComponentProps< CompositeGroupLabelProps, 'div', false >
->( function CompositeGroupLabel( props, ref ) {
-	const context = useCompositeContext();
-	return (
-		<Ariakit.CompositeGroupLabel
-			store={ context?.store }
-			{ ...props }
-			ref={ ref }
-		/>
-	);
-} );
-GroupLabel.displayName = 'Composite.GroupLabel';
-
-const Item = forwardRef<
-	HTMLButtonElement,
-	WordPressComponentProps< CompositeItemProps, 'button', false >
->( function CompositeItem( props, ref ) {
-	const context = useCompositeContext();
-	return (
-		<Ariakit.CompositeItem
-			store={ context?.store }
-			{ ...props }
-			ref={ ref }
-		/>
-	);
-} );
-Item.displayName = 'Composite.Item';
-
-const Row = forwardRef<
-	HTMLDivElement,
-	WordPressComponentProps< CompositeRowProps, 'div', false >
->( function CompositeRow( props, ref ) {
-	const context = useCompositeContext();
-	return (
-		<Ariakit.CompositeRow
-			store={ context?.store }
-			{ ...props }
-			ref={ ref }
-		/>
-	);
-} );
-Row.displayName = 'Composite.Row';
-
-const Hover = forwardRef<
-	HTMLDivElement,
-	WordPressComponentProps< CompositeHoverProps, 'div', false >
->( function CompositeHover( props, ref ) {
-	const context = useCompositeContext();
-	return (
-		<Ariakit.CompositeHover
-			store={ context?.store }
-			{ ...props }
-			ref={ ref }
-		/>
-	);
-} );
-Hover.displayName = 'Composite.Hover';
-
-const Typeahead = forwardRef<
-	HTMLDivElement,
-	WordPressComponentProps< CompositeTypeaheadProps, 'div', false >
->( function CompositeTypeahead( props, ref ) {
-	const context = useCompositeContext();
-	return (
-		<Ariakit.CompositeTypeahead
-			store={ context?.store }
-			{ ...props }
-			ref={ ref }
-		/>
-	);
-} );
-Typeahead.displayName = 'Composite.Typeahead';
+import { CompositeContext } from './context';
+import { CompositeGroup } from './group';
+import { CompositeGroupLabel } from './group-label';
+import { CompositeHover } from './hover';
+import { CompositeItem } from './item';
+import { CompositeRow } from './row';
+import { CompositeTypeahead } from './typeahead';
+import type { CompositeProps } from './types';
 
 /**
  * Renders a widget based on the WAI-ARIA [`composite`](https://w3c.github.io/aria/#composite)
@@ -180,9 +52,44 @@ export const Composite = Object.assign(
 		HTMLDivElement,
 		WordPressComponentProps< CompositeProps, 'div', false >
 	>( function Composite(
-		{ children, store, disabled = false, ...props },
+		{
+			// Composite store props
+			activeId,
+			defaultActiveId,
+			setActiveId,
+			focusLoop = false,
+			focusWrap = false,
+			focusShift = false,
+			virtualFocus = false,
+			orientation = 'both',
+			rtl = false,
+
+			// Composite component props
+			children,
+			disabled = false,
+
+			// To be removed
+			store: storeProp,
+
+			// Rest props
+			...props
+		},
 		ref
 	) {
+		const newStore = Ariakit.useCompositeStore( {
+			activeId,
+			defaultActiveId,
+			setActiveId,
+			focusLoop,
+			focusWrap,
+			focusShift,
+			virtualFocus,
+			orientation,
+			rtl,
+		} );
+
+		const store = storeProp || newStore;
+
 		const contextValue = useMemo(
 			() => ( {
 				store,
@@ -204,7 +111,6 @@ export const Composite = Object.assign(
 		);
 	} ),
 	{
-		displayName: 'Composite',
 		/**
 		 * Renders a group element for composite items.
 		 *
@@ -222,7 +128,9 @@ export const Composite = Object.assign(
 		 * </Composite>
 		 * ```
 		 */
-		Group,
+		Group: Object.assign( 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
@@ -242,7 +150,9 @@ export const Composite = Object.assign(
 		 * </Composite>
 		 * ```
 		 */
-		GroupLabel,
+		GroupLabel: Object.assign( CompositeGroupLabel, {
+			displayName: 'Composite.GroupLabel',
+		} ),
 		/**
 		 * Renders a composite item.
 		 *
@@ -258,7 +168,7 @@ export const Composite = Object.assign(
 		 * </Composite>
 		 * ```
 		 */
-		Item,
+		Item: Object.assign( 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
@@ -283,7 +193,7 @@ export const Composite = Object.assign(
 		 * </Composite>
 		 * ```
 		 */
-		Row,
+		Row: Object.assign( 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
@@ -304,7 +214,9 @@ export const Composite = Object.assign(
 		 * </Composite>
 		 * ```
 		 */
-		Hover,
+		Hover: Object.assign( CompositeHover, {
+			displayName: 'Composite.Hover',
+		} ),
 		/**
 		 * Renders a component that adds typeahead functionality to composite
 		 * components. Hitting printable character keys will move focus to the next
@@ -321,7 +233,9 @@ export const Composite = Object.assign(
 		 * </Composite>
 		 * ```
 		 */
-		Typeahead,
+		Typeahead: Object.assign( 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
@@ -336,6 +250,8 @@ export const Composite = Object.assign(
 		 * const compositeContext = useContext( Composite.Context );
 		 * ```
 		 */
-		Context: CompositeContext,
+		Context: Object.assign( CompositeContext, {
+			displayName: 'Composite.Context',
+		} ),
 	}
 );

package/src/composite/item.tsx

@@ -0,0 +1,30 @@
+/**
+ * External dependencies
+ */
+import * as Ariakit from '@ariakit/react';
+
+/**
+ * WordPress dependencies
+ */
+import { forwardRef } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import type { WordPressComponentProps } from '../context';
+import { useCompositeContext } from './context';
+import type { CompositeItemProps } from './types';
+
+export const CompositeItem = forwardRef<
+	HTMLButtonElement,
+	WordPressComponentProps< CompositeItemProps, 'button', false >
+>( function CompositeItem( props, ref ) {
+	const context = useCompositeContext();
+	return (
+		<Ariakit.CompositeItem
+			store={ context?.store }
+			{ ...props }
+			ref={ ref }
+		/>
+	);
+} );

package/src/composite/legacy/index.tsx

@@ -21,7 +21,8 @@ import { forwardRef } from '@wordpress/element';
 /**
  * Internal dependencies
  */
-import { Composite as Current, useCompositeStore } from '..';
+import { Composite as Current } from '..';
+import { useCompositeStore } from '../store';
 import { useInstanceId } from '@wordpress/compose';
 
 type Orientation = 'horizontal' | 'vertical';

package/src/composite/row.tsx

@@ -0,0 +1,30 @@
+/**
+ * External dependencies
+ */
+import * as Ariakit from '@ariakit/react';
+
+/**
+ * WordPress dependencies
+ */
+import { forwardRef } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import type { WordPressComponentProps } from '../context';
+import { useCompositeContext } from './context';
+import type { CompositeRowProps } from './types';
+
+export const CompositeRow = forwardRef<
+	HTMLDivElement,
+	WordPressComponentProps< CompositeRowProps, 'div', false >
+>( function CompositeRow( props, ref ) {
+	const context = useCompositeContext();
+	return (
+		<Ariakit.CompositeRow
+			store={ context?.store }
+			{ ...props }
+			ref={ ref }
+		/>
+	);
+} );

package/src/composite/store.ts

@@ -0,0 +1,46 @@
+/**
+ * External dependencies
+ */
+import * as Ariakit from '@ariakit/react';
+
+/**
+ * Internal dependencies
+ */
+import type { CompositeStoreProps } from './types';
+
+// Props are already documented in TypeScript types.
+// eslint-disable-next-line jsdoc/require-param
+/**
+ * Creates a composite store.
+ *
+ * @example
+ * ```jsx
+ * import { Composite, useCompositeStore } from '@wordpress/components';
+ *
+ * const store = useCompositeStore();
+ * <Composite store={store}>
+ *   <Composite.Item>Item</Composite.Item>
+ *   <Composite.Item>Item</Composite.Item>
+ *   <Composite.Item>Item</Composite.Item>
+ * </Composite>
+ * ```
+ */
+export function useCompositeStore( {
+	focusLoop = false,
+	focusWrap = false,
+	focusShift = false,
+	virtualFocus = false,
+	orientation = 'both',
+	rtl = false,
+	...props
+}: CompositeStoreProps = {} ) {
+	return Ariakit.useCompositeStore( {
+		focusLoop,
+		focusWrap,
+		focusShift,
+		virtualFocus,
+		orientation,
+		rtl,
+		...props,
+	} );
+}