@wordpress/ui 0.13.1-next.v.202605131006.0 → 0.14.0

package/src/form/primitives/autocomplete/test/index.test.tsx

@@ -1,7 +1,9 @@
 import { render, screen, waitFor } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { createRef } from '@wordpress/element';
+import type { ReactNode } from 'react';
 import * as Autocomplete from '../index';
+import { useEnableWpCompatOverlaySlot } from '../../../../utils/use-enable-wp-compat-overlay-slot';
 
 const ITEMS = [
 	{ id: '1', value: 'Item 1' },
@@ -9,6 +11,15 @@ const ITEMS = [
 	{ id: '3', value: 'Item 3' },
 ];
 
+function renderDisabledAutocompleteWithClear() {
+	return render(
+		<Autocomplete.Root items={ ITEMS } disabled defaultValue="Item 1">
+			<Autocomplete.Input placeholder="Search" />
+			<Autocomplete.Clear />
+		</Autocomplete.Root>
+	);
+}
+
 describe( 'Autocomplete', () => {
 	it( 'forwards ref', async () => {
 		const user = userEvent.setup();
@@ -159,4 +170,212 @@ describe( 'Autocomplete', () => {
 			);
 		} );
 	} );
+
+	describe( 'positioner', () => {
+		it( 'should render the custom positioner element wrapping the popup content', async () => {
+			const user = userEvent.setup();
+
+			render(
+				<Autocomplete.Root items={ ITEMS }>
+					<Autocomplete.Input placeholder="Search" />
+					<Autocomplete.Popup
+						positioner={
+							<Autocomplete.Positioner data-testid="custom-positioner" />
+						}
+					>
+						<Autocomplete.List>
+							<Autocomplete.ListBody>
+								<Autocomplete.Collection>
+									{ ( item ) => (
+										<Autocomplete.Item
+											key={ item.id }
+											value={ item }
+										>
+											{ item.value }
+										</Autocomplete.Item>
+									) }
+								</Autocomplete.Collection>
+							</Autocomplete.ListBody>
+						</Autocomplete.List>
+					</Autocomplete.Popup>
+				</Autocomplete.Root>
+			);
+
+			await user.type( screen.getByRole( 'combobox' ), 'Item 1' );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			const positioner = screen.getByTestId( 'custom-positioner' );
+
+			expect( positioner ).toContainElement( item );
+		} );
+	} );
+
+	// Slot is identified by a data attribute, not a user-facing role/text.
+	/* eslint-disable testing-library/no-node-access */
+	describe( 'wp compat overlay slot', () => {
+		const SLOT_SELECTOR = '[data-wp-compat-overlay-slot]';
+
+		// Exercises the public opt-in path rather than poking the flag.
+		function WithSlotEnabled( { children }: { children: ReactNode } ) {
+			useEnableWpCompatOverlaySlot();
+			return <>{ children }</>;
+		}
+
+		afterEach( () => {
+			// The hook is one-way at runtime; reset explicitly between tests.
+			delete ( window as { __wpUiCompatOverlaySlotEnabled?: boolean } )
+				.__wpUiCompatOverlaySlotEnabled;
+			document
+				.querySelectorAll( SLOT_SELECTOR )
+				.forEach( ( el ) => el.remove() );
+		} );
+
+		it( 'portals the popup into the slot when the consumer opts in', async () => {
+			const user = userEvent.setup();
+
+			render(
+				<WithSlotEnabled>
+					<Autocomplete.Root items={ ITEMS }>
+						<Autocomplete.Input placeholder="Search" />
+						<Autocomplete.Popup>
+							<Autocomplete.List>
+								<Autocomplete.ListBody>
+									<Autocomplete.Collection>
+										{ ( item ) => (
+											<Autocomplete.Item
+												key={ item.id }
+												value={ item }
+											>
+												{ item.value }
+											</Autocomplete.Item>
+										) }
+									</Autocomplete.Collection>
+								</Autocomplete.ListBody>
+							</Autocomplete.List>
+						</Autocomplete.Popup>
+					</Autocomplete.Root>
+				</WithSlotEnabled>
+			);
+
+			await user.type( screen.getByRole( 'combobox' ), 'Item 1' );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			expect( item ).toBeVisible();
+
+			const slot = document.querySelector( SLOT_SELECTOR );
+			expect( slot ).not.toBeNull();
+			expect( slot ).toContainElement( item );
+		} );
+
+		it( 'does not create a slot when the consumer has not opted in (dormant default)', async () => {
+			const user = userEvent.setup();
+
+			render(
+				<Autocomplete.Root items={ ITEMS }>
+					<Autocomplete.Input placeholder="Search" />
+					<Autocomplete.Popup>
+						<Autocomplete.List>
+							<Autocomplete.ListBody>
+								<Autocomplete.Collection>
+									{ ( item ) => (
+										<Autocomplete.Item
+											key={ item.id }
+											value={ item }
+										>
+											{ item.value }
+										</Autocomplete.Item>
+									) }
+								</Autocomplete.Collection>
+							</Autocomplete.ListBody>
+						</Autocomplete.List>
+					</Autocomplete.Popup>
+				</Autocomplete.Root>
+			);
+
+			await user.type( screen.getByRole( 'combobox' ), 'Item 1' );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			expect( item ).toBeVisible();
+
+			expect( document.querySelector( SLOT_SELECTOR ) ).toBeNull();
+		} );
+
+		it( 'lets a caller-supplied portal container override the slot', async () => {
+			const user = userEvent.setup();
+			const containerRef = createRef< HTMLDivElement >();
+
+			render(
+				<WithSlotEnabled>
+					<Autocomplete.Root items={ ITEMS }>
+						<Autocomplete.Input placeholder="Search" />
+						<div
+							ref={ containerRef }
+							data-testid="custom-container"
+						/>
+						<Autocomplete.Popup
+							portal={
+								<Autocomplete.Portal
+									container={ containerRef }
+								/>
+							}
+						>
+							<Autocomplete.List>
+								<Autocomplete.ListBody>
+									<Autocomplete.Collection>
+										{ ( item ) => (
+											<Autocomplete.Item
+												key={ item.id }
+												value={ item }
+											>
+												{ item.value }
+											</Autocomplete.Item>
+										) }
+									</Autocomplete.Collection>
+								</Autocomplete.ListBody>
+							</Autocomplete.List>
+						</Autocomplete.Popup>
+					</Autocomplete.Root>
+				</WithSlotEnabled>
+			);
+
+			await user.type( screen.getByRole( 'combobox' ), 'Item 1' );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			expect( item ).toBeVisible();
+			expect( screen.getByTestId( 'custom-container' ) ).toContainElement(
+				item
+			);
+		} );
+	} );
+	/* eslint-enable testing-library/no-node-access */
+
+	describe( 'when disabled', () => {
+		it( 'hides the clear button from screen readers', () => {
+			renderDisabledAutocompleteWithClear();
+
+			expect(
+				screen.queryByRole( 'button', { name: 'Clear' } )
+			).not.toBeInTheDocument();
+		} );
+
+		it( 'does not show a tooltip when the clear button is hovered', async () => {
+			const user = userEvent.setup( { pointerEventsCheck: 0 } );
+			renderDisabledAutocompleteWithClear();
+
+			const clearButton = screen.getByLabelText( 'Clear', {
+				selector: 'button',
+			} );
+			await user.hover( clearButton );
+
+			expect( screen.queryByRole( 'tooltip' ) ).not.toBeInTheDocument();
+		} );
+	} );
 } );

package/src/form/primitives/autocomplete/types.ts

@@ -1,12 +1,12 @@
 import type { Autocomplete as _Autocomplete } from '@base-ui/react/autocomplete';
-import type { ComponentPropsWithoutRef, ReactElement } from 'react';
+import type { ReactElement } from 'react';
 import type { ComponentProps } from '../../../utils/types';
 
 export type AutocompleteCollectionProps = _Autocomplete.Collection.Props;
 
-export type PortalProps = ComponentPropsWithoutRef<
-	typeof _Autocomplete.Portal
->;
+export type PortalProps = ComponentProps< typeof _Autocomplete.Portal >;
+
+export type PositionerProps = ComponentProps< typeof _Autocomplete.Positioner >;
 
 export type AutocompleteClearProps = ComponentProps<
 	typeof _Autocomplete.Clear
@@ -58,17 +58,17 @@ export type AutocompletePopupProps = ComponentProps<
 	 * portal element; they would be ignored.
 	 */
 	portal?: ReactElement< Omit< PortalProps, 'children' > >;
-};
-
-export type AutocompleteRootProps = ComponentProps<
-	typeof _Autocomplete.Root
-> & {
-	children?: React.ReactNode;
-};
-
-export type AutocompleteValueProps = {
 	/**
-	 * Can be used to override the current value of the autocomplete.
+	 * Optional positioner element, typically `<Autocomplete.Positioner />`
+	 * with custom positioning props (`side`, `align`, `sideOffset`, collision
+	 * settings, etc.). When omitted, `Autocomplete.Popup` uses
+	 * `Autocomplete.Positioner` with default props. Do not pass `children` on
+	 * the positioner element; they would be ignored.
 	 */
-	children?: _Autocomplete.Value.Props[ 'children' ];
+	positioner?: ReactElement< Omit< PositionerProps, 'children' > >;
 };
+
+export type AutocompleteRootProps< Value = unknown > =
+	_Autocomplete.Root.Props< Value >;
+
+export type AutocompleteValueProps = _Autocomplete.Value.Props;

package/src/form/primitives/constants.ts

@@ -1,10 +1,13 @@
-import type { Select as _Select } from '@base-ui/react/select';
-
 /**
- * Shared positioning props for item popups (Select, Combobox, etc.).
+ * Shared positioning defaults for item-list popups. Consumed as individual
+ * default values by `Select.Positioner` and `Autocomplete.Positioner`. Each
+ * key is validated by the consuming positioner's prop types at the use
+ * site, so a value here that does not satisfy either Base UI positioner's
+ * type will surface as a type error in `select/positioner.tsx` or
+ * `autocomplete/positioner.tsx`.
  */
 export const ITEM_POPUP_POSITIONER_PROPS = {
 	align: 'start',
 	sideOffset: 8,
 	collisionPadding: 12,
-} satisfies Partial< _Select.Positioner.Props >;
+} as const;

package/src/form/primitives/select/index.ts

@@ -1,5 +1,6 @@
 export { Item } from './item';
-export { Portal } from './portal';
 export { Popup } from './popup';
+export { Portal } from './portal';
+export { Positioner } from './positioner';
 export { Root } from './root';
 export { Trigger } from './trigger';

package/src/form/primitives/select/popup.tsx

@@ -7,49 +7,45 @@ import {
 } from '@wordpress/theme';
 import { unlock } from '../../../lock-unlock';
 import { Portal } from './portal';
+import { Positioner } from './positioner';
 import { renderSlotWithChildren } from '../../../utils/render-slot-with-children';
 import itemPopupStyles from '../../../utils/css/item-popup.module.css';
-import resetStyles from '../../../utils/css/resets.module.css';
-import styles from './style.module.css';
 import type { SelectPopupProps } from './types';
-import { ITEM_POPUP_POSITIONER_PROPS } from '../constants';
 
 const ThemeProvider: typeof ThemeProviderType =
 	unlock( themePrivateApis ).ThemeProvider;
 
 export const Popup = forwardRef< HTMLDivElement, SelectPopupProps >(
-	function Popup( { className, portal, children, ...restProps }, ref ) {
-		const portalChildren = (
-			<_Select.Positioner
-				{ ...ITEM_POPUP_POSITIONER_PROPS }
-				alignItemWithTrigger={ false }
-				className={ clsx(
-					resetStyles[ 'box-sizing' ],
-					styles.positioner
-				) }
-			>
-				<ThemeProvider>
-					<_Select.Popup
-						ref={ ref }
-						className={ clsx( itemPopupStyles.popup, className ) }
-						{ ...restProps }
-					>
-						<_Select.List className={ itemPopupStyles.list }>
-							<div
-								className={
-									itemPopupStyles[
-										'list-scrollable-container'
-									]
-								}
-							>
-								{ children }
-							</div>
-						</_Select.List>
-					</_Select.Popup>
-				</ThemeProvider>
-			</_Select.Positioner>
+	function Popup(
+		{ className, portal, positioner, children, ...restProps },
+		ref
+	) {
+		const popupContent = (
+			<ThemeProvider>
+				<_Select.Popup
+					ref={ ref }
+					className={ clsx( itemPopupStyles.popup, className ) }
+					{ ...restProps }
+				>
+					<_Select.List className={ itemPopupStyles.list }>
+						<div
+							className={
+								itemPopupStyles[ 'list-scrollable-container' ]
+							}
+						>
+							{ children }
+						</div>
+					</_Select.List>
+				</_Select.Popup>
+			</ThemeProvider>
 		);
 
-		return renderSlotWithChildren( portal, <Portal />, portalChildren );
+		const positionedPopup = renderSlotWithChildren(
+			positioner,
+			<Positioner />,
+			popupContent
+		);
+
+		return renderSlotWithChildren( portal, <Portal />, positionedPopup );
 	}
 );

package/src/form/primitives/select/portal.tsx

@@ -1,16 +1,23 @@
 import { Select as _Select } from '@base-ui/react/select';
 import { forwardRef } from '@wordpress/element';
 import type { PortalProps } from './types';
+import { getWpCompatOverlaySlot } from '../../../utils/wp-compat-overlay-slot';
 
 /**
- * Root element that portals `Select` listbox content. Pass to
- * `Select.Popup`'s `portal` prop. When `portal` is omitted, `Select.Popup`
- * uses this component with default props.
+ * Used to apply custom portal behavior to `Select`'s listbox content.
+ * `container` defaults to the `@wordpress/ui` compat overlay slot.
  */
-const Portal = forwardRef< HTMLDivElement, PortalProps >(
-	function SelectPortal( props, ref ) {
-		return <_Select.Portal ref={ ref } { ...props } />;
-	}
-);
+const Portal = forwardRef< HTMLDivElement, PortalProps >( function SelectPortal(
+	{ container, ...restProps },
+	ref
+) {
+	return (
+		<_Select.Portal
+			container={ container ?? getWpCompatOverlaySlot() }
+			{ ...restProps }
+			ref={ ref }
+		/>
+	);
+} );
 
 export { Portal };

package/src/form/primitives/select/positioner.tsx

@@ -0,0 +1,33 @@
+import clsx from 'clsx';
+import { Select as _Select } from '@base-ui/react/select';
+import { forwardRef } from '@wordpress/element';
+import type { PositionerProps } from './types';
+import resetStyles from '../../../utils/css/resets.module.css';
+import styles from './style.module.css';
+import { ITEM_POPUP_POSITIONER_PROPS } from '../constants';
+
+/**
+ * Used to apply custom positioning to `Select`'s listbox content.
+ */
+const Positioner = forwardRef< HTMLDivElement, PositionerProps >(
+	function SelectPositioner( { className, ...props }, ref ) {
+		return (
+			<_Select.Positioner
+				{ ...ITEM_POPUP_POSITIONER_PROPS }
+				// Override Base UI's `true` default so the popup is placed
+				// relative to the trigger rather than aligned with the
+				// highlighted item. Consumers can opt back in by passing `true`.
+				alignItemWithTrigger={ false }
+				{ ...props }
+				ref={ ref }
+				className={ clsx(
+					resetStyles[ 'box-sizing' ],
+					styles.positioner,
+					className
+				) }
+			/>
+		);
+	}
+);
+
+export { Positioner };

package/src/form/primitives/select/stories/index.story.tsx

@@ -7,6 +7,7 @@ const meta: Meta< typeof Select.Root > = {
 	subcomponents: {
 		'Select.Trigger': Select.Trigger,
 		'Select.Portal': Select.Portal,
+		'Select.Positioner': Select.Positioner,
 		'Select.Popup': Select.Popup,
 		'Select.Item': Select.Item,
 	},

package/src/form/primitives/select/test/index.test.tsx

@@ -1,7 +1,9 @@
 import { render, screen, within } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { createRef } from '@wordpress/element';
+import type { ReactNode } from 'react';
 import * as Select from '../index';
+import { useEnableWpCompatOverlaySlot } from '../../../../utils/use-enable-wp-compat-overlay-slot';
 
 describe( 'Select', () => {
 	it( 'supports object item values', async () => {
@@ -211,4 +213,136 @@ describe( 'Select', () => {
 			);
 		} );
 	} );
+
+	describe( 'positioner', () => {
+		it( 'should render the custom positioner element wrapping the popup content', async () => {
+			const user = userEvent.setup();
+
+			render(
+				<Select.Root>
+					<Select.Trigger />
+					<Select.Popup
+						positioner={
+							<Select.Positioner data-testid="custom-positioner" />
+						}
+					>
+						<Select.Item value="Item 1">Item 1</Select.Item>
+					</Select.Popup>
+				</Select.Root>
+			);
+
+			await user.click( screen.getByRole( 'combobox' ) );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			const positioner = screen.getByTestId( 'custom-positioner' );
+
+			expect( positioner ).toContainElement( item );
+		} );
+	} );
+
+	// Slot is identified by a data attribute, not a user-facing role/text.
+	/* eslint-disable testing-library/no-node-access */
+	describe( 'wp compat overlay slot', () => {
+		const SLOT_SELECTOR = '[data-wp-compat-overlay-slot]';
+
+		// Exercises the public opt-in path rather than poking the flag.
+		function WithSlotEnabled( { children }: { children: ReactNode } ) {
+			useEnableWpCompatOverlaySlot();
+			return <>{ children }</>;
+		}
+
+		afterEach( () => {
+			// The hook is one-way at runtime; reset explicitly between tests.
+			delete ( window as { __wpUiCompatOverlaySlotEnabled?: boolean } )
+				.__wpUiCompatOverlaySlotEnabled;
+			document
+				.querySelectorAll( SLOT_SELECTOR )
+				.forEach( ( el ) => el.remove() );
+		} );
+
+		it( 'portals the popup into the slot when the consumer opts in', async () => {
+			const user = userEvent.setup();
+
+			render(
+				<WithSlotEnabled>
+					<Select.Root>
+						<Select.Trigger />
+						<Select.Popup>
+							<Select.Item value="Item 1">Item 1</Select.Item>
+						</Select.Popup>
+					</Select.Root>
+				</WithSlotEnabled>
+			);
+
+			await user.click( screen.getByRole( 'combobox' ) );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			expect( item ).toBeVisible();
+
+			const slot = document.querySelector( SLOT_SELECTOR );
+			expect( slot ).not.toBeNull();
+			expect( slot ).toContainElement( item );
+		} );
+
+		it( 'does not create a slot when the consumer has not opted in (dormant default)', async () => {
+			const user = userEvent.setup();
+
+			render(
+				<Select.Root>
+					<Select.Trigger />
+					<Select.Popup>
+						<Select.Item value="Item 1">Item 1</Select.Item>
+					</Select.Popup>
+				</Select.Root>
+			);
+
+			await user.click( screen.getByRole( 'combobox' ) );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			expect( item ).toBeVisible();
+
+			expect( document.querySelector( SLOT_SELECTOR ) ).toBeNull();
+		} );
+
+		it( 'lets a caller-supplied portal container override the slot', async () => {
+			const user = userEvent.setup();
+			const containerRef = createRef< HTMLDivElement >();
+
+			render(
+				<WithSlotEnabled>
+					<Select.Root>
+						<Select.Trigger />
+						<div
+							ref={ containerRef }
+							data-testid="custom-container"
+						/>
+						<Select.Popup
+							portal={
+								<Select.Portal container={ containerRef } />
+							}
+						>
+							<Select.Item value="Item 1">Item 1</Select.Item>
+						</Select.Popup>
+					</Select.Root>
+				</WithSlotEnabled>
+			);
+
+			await user.click( screen.getByRole( 'combobox' ) );
+
+			const item = await screen.findByRole( 'option', {
+				name: 'Item 1',
+			} );
+			expect( item ).toBeVisible();
+			expect( screen.getByTestId( 'custom-container' ) ).toContainElement(
+				item
+			);
+		} );
+	} );
+	/* eslint-enable testing-library/no-node-access */
 } );

package/src/form/primitives/select/types.ts

@@ -1,10 +1,12 @@
 import type { Select as _Select } from '@base-ui/react/select';
-import type { ComponentPropsWithoutRef, ReactElement } from 'react';
+import type { ReactElement } from 'react';
 
 import type { ComponentProps } from '../../../utils/types';
 import type { InputLayoutProps } from '../input-layout/types';
 
-export type PortalProps = ComponentPropsWithoutRef< typeof _Select.Portal >;
+export type PortalProps = ComponentProps< typeof _Select.Portal >;
+
+export type PositionerProps = ComponentProps< typeof _Select.Positioner >;
 
 // The second type parameter is the `multiple` flag (currently disabled).
 export type SelectRootProps< Value = unknown > = Omit<
@@ -54,6 +56,14 @@ export type SelectPopupProps = ComponentProps< typeof _Select.Popup > & {
 	 * be ignored.
 	 */
 	portal?: ReactElement< Omit< PortalProps, 'children' > >;
+	/**
+	 * Optional positioner element, typically `<Select.Positioner />` with
+	 * custom positioning props (`side`, `align`, `sideOffset`, collision
+	 * settings, etc.). When omitted, `Select.Popup` uses `Select.Positioner`
+	 * with default props. Do not pass `children` on the positioner element;
+	 * they would be ignored.
+	 */
+	positioner?: ReactElement< Omit< PositionerProps, 'children' > >;
 };
 
 export type SelectItemProps = Omit<