@base-ui/react 1.6.0 → 1.7.0

package/docs/react/components/autocomplete.md

@@ -407,7 +407,7 @@ import { Autocomplete } from '@base-ui/react/autocomplete';
 ## TypeScript inference
 
 Autocomplete infers the item type from the `items` prop passed to `<Autocomplete.Root>`.
-If using `itemToStringValue`, the value prop on the `<Autocomplete.Item>` must match the type of an item in the `items` array.
+The `value` prop on `<Autocomplete.Item>` must match the type of an item in the `items` array, which also ensures that props like `itemToStringValue` infer the correct item type.
 
 ## Examples
 
@@ -3246,12 +3246,18 @@ export default function ExampleAutocompleteCommandPalette() {
               autoHighlight="always"
               keepHighlight
             >
-              <Autocomplete.Input
-                className="relative z-1 h-10 w-full border-0 bg-white px-3 text-sm any-pointer-coarse:text-base font-normal text-neutral-950 placeholder:text-neutral-500 focus:outline-2 focus:outline-solid focus:outline-neutral-950 dark:focus:outline-white dark:bg-neutral-950 dark:text-white dark:placeholder:text-neutral-400"
-                aria-label="Search commands"
-                aria-describedby={shortcutsDescriptionId}
-                placeholder="Search for apps and commands…"
-              />
+              <Autocomplete.InputGroup className="relative z-1 flex cursor-text items-center gap-2 bg-white pl-3 focus-within:outline-2 focus-within:outline-solid focus-within:-outline-offset-1 focus-within:outline-neutral-950 dark:bg-neutral-950 dark:focus-within:outline-white">
+                <MagnifyingGlassIcon
+                  className="h-4 w-4 shrink-0 text-neutral-500 dark:text-neutral-400"
+                  aria-hidden
+                />
+                <Autocomplete.Input
+                  className="h-10 w-full border-0 bg-transparent pr-3 text-sm any-pointer-coarse:text-base font-normal text-neutral-950 outline-none placeholder:text-neutral-500 dark:text-white dark:placeholder:text-neutral-400"
+                  aria-label="Search commands"
+                  aria-describedby={shortcutsDescriptionId}
+                  placeholder="Search for apps and commands…"
+                />
+              </Autocomplete.InputGroup>
               <Dialog.Close className="sr-only">Close command palette</Dialog.Close>
 
               <ScrollArea.Root className="relative flex max-h-[min(60dvh,24rem)] min-h-0 flex-[0_1_auto] overflow-hidden border-t border-neutral-950 dark:border-t-white">
@@ -3317,6 +3323,25 @@ export default function ExampleAutocompleteCommandPalette() {
   );
 }
 
+function MagnifyingGlassIcon(props: React.ComponentProps<'svg'>) {
+  return (
+    <svg
+      width="16"
+      height="16"
+      viewBox="0 0 16 16"
+      fill="none"
+      stroke="currentColor"
+      strokeLinecap="square"
+      strokeLinejoin="round"
+      {...props}
+      style={{ display: 'block', ...props.style }}
+    >
+      <path d="m11 11 3.5 3.5" />
+      <circle cx="7" cy="7" r="5.5" />
+    </svg>
+  );
+}
+
 interface Item {
   value: string;
   label: string;
@@ -3487,11 +3512,45 @@ This example shows how to implement the component using CSS Modules.
   }
 }
 
-.Input {
+.InputGroup {
   box-sizing: border-box;
   position: relative;
   z-index: 1;
-  padding: 0 0.75rem;
+  display: flex;
+  align-items: center;
+  gap: 0.5rem;
+  padding-left: 0.75rem;
+  background-color: white;
+  cursor: text;
+
+  @media (prefers-color-scheme: dark) {
+    background-color: oklch(14.5% 0 0deg);
+  }
+
+  &:focus-within {
+    outline: 2px solid oklch(14.5% 0 0deg);
+    outline-offset: -1px;
+
+    @media (prefers-color-scheme: dark) {
+      outline-color: white;
+    }
+  }
+}
+
+.InputIcon {
+  flex-shrink: 0;
+  width: 1rem;
+  height: 1rem;
+  color: oklch(55.6% 0 0deg);
+
+  @media (prefers-color-scheme: dark) {
+    color: oklch(70.8% 0 0deg);
+  }
+}
+
+.Input {
+  box-sizing: border-box;
+  padding: 0 0.75rem 0 0;
   margin: 0;
   border: none;
   width: 100%;
@@ -3501,7 +3560,7 @@ This example shows how to implement the component using CSS Modules.
   font-size: 0.875rem;
   line-height: 1.25rem;
   font-weight: 400;
-  background-color: white;
+  background-color: transparent;
   color: oklch(14.5% 0 0deg);
   outline: none;
 
@@ -3511,7 +3570,6 @@ This example shows how to implement the component using CSS Modules.
   }
 
   @media (prefers-color-scheme: dark) {
-    background-color: oklch(14.5% 0 0deg);
     color: white;
   }
 
@@ -3522,14 +3580,6 @@ This example shows how to implement the component using CSS Modules.
       color: oklch(70.8% 0 0deg);
     }
   }
-
-  &:focus {
-    outline: 2px solid oklch(14.5% 0 0deg);
-
-    @media (prefers-color-scheme: dark) {
-      outline-color: white;
-    }
-  }
 }
 
 .ListArea {
@@ -3721,7 +3771,8 @@ This example shows how to implement the component using CSS Modules.
   padding: 0 0.25rem;
   font-size: 0.625rem;
   font-family:
-    ui-monospace, SFMono-Regular, 'SF Mono', Consolas, 'Liberation Mono', Menlo, monospace;
+    'Paper Mono', ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono',
+    'Courier New', monospace;
   font-weight: 400;
   line-height: 1;
   color: oklch(43.9% 0 0deg);
@@ -3779,12 +3830,15 @@ export default function ExampleAutocompleteCommandPalette() {
               autoHighlight="always"
               keepHighlight
             >
-              <Autocomplete.Input
-                className={styles.Input}
-                aria-label="Search commands"
-                aria-describedby={shortcutsDescriptionId}
-                placeholder="Search for apps and commands…"
-              />
+              <Autocomplete.InputGroup className={styles.InputGroup}>
+                <MagnifyingGlassIcon className={styles.InputIcon} aria-hidden />
+                <Autocomplete.Input
+                  className={styles.Input}
+                  aria-label="Search commands"
+                  aria-describedby={shortcutsDescriptionId}
+                  placeholder="Search for apps and commands…"
+                />
+              </Autocomplete.InputGroup>
               <Dialog.Close className={styles.VisuallyHidden}>Close command palette</Dialog.Close>
 
               <ScrollArea.Root className={styles.ListArea}>
@@ -3846,6 +3900,25 @@ export default function ExampleAutocompleteCommandPalette() {
   );
 }
 
+function MagnifyingGlassIcon(props: React.ComponentProps<'svg'>) {
+  return (
+    <svg
+      width="16"
+      height="16"
+      viewBox="0 0 16 16"
+      fill="none"
+      stroke="currentColor"
+      strokeLinecap="square"
+      strokeLinejoin="round"
+      {...props}
+      style={{ display: 'block', ...props.style }}
+    >
+      <path d="m11 11 3.5 3.5" />
+      <circle cx="7" cy="7" r="5.5" />
+    </svg>
+  );
+}
+
 interface Item {
   value: string;
   label: string;
@@ -3942,6 +4015,7 @@ export default function ExampleEmojiPicker() {
         <input
           ref={textInputRef}
           type="text"
+          aria-label="Message"
           className="-mr-px h-8 flex-1 border border-r-0 border-neutral-950 px-2 text-sm any-pointer-coarse:text-base font-normal text-neutral-950 placeholder:text-neutral-500 dark:placeholder:text-neutral-400 bg-white dark:bg-neutral-950 focus:relative focus:outline-2 focus:-outline-offset-1 focus:outline-solid focus:outline-neutral-950 dark:focus:outline-white dark:border-white dark:text-white"
           placeholder="iMessage"
           value={textValue}
@@ -3962,7 +4036,7 @@ export default function ExampleEmojiPicker() {
           }}
         >
           <Autocomplete.Trigger
-            className="flex size-8 items-center justify-center border border-neutral-950 bg-transparent text-xl leading-none text-neutral-950 outline-none hover:bg-neutral-100 active:bg-neutral-200 focus-visible:outline-2 focus-visible:-outline-offset-1 focus-visible:outline-solid focus-visible:outline-neutral-950 dark:focus-visible:outline-white data-popup-open:bg-neutral-100 dark:border-white dark:text-white dark:hover:bg-neutral-800 dark:active:bg-neutral-700 dark:data-popup-open:bg-neutral-800"
+            className="flex size-8 items-center justify-center border border-neutral-950 bg-transparent text-xl leading-none text-neutral-950 outline-none hover:bg-neutral-100 active:bg-neutral-200 focus-visible:outline-2 focus-visible:-outline-offset-1 focus-visible:outline-solid focus-visible:outline-neutral-950 dark:focus-visible:outline-white data-pressed:bg-neutral-100 dark:border-white dark:text-white dark:hover:bg-neutral-800 dark:active:bg-neutral-700 dark:data-pressed:bg-neutral-800"
             aria-label="Choose emoji"
           >
             😀
@@ -3974,6 +4048,7 @@ export default function ExampleEmojiPicker() {
                 aria-label="Select emoji"
               >
                 <Autocomplete.Input
+                  aria-label="Search emojis"
                   placeholder="Search emojis…"
                   className="h-8 w-64 max-w-full border border-neutral-950 bg-white px-2 text-sm any-pointer-coarse:text-base font-normal text-neutral-950 placeholder:text-neutral-500 dark:placeholder:text-neutral-400 focus:outline-2 focus:-outline-offset-2 focus:outline-solid focus:outline-neutral-950 dark:focus:outline-white dark:border-white dark:bg-neutral-950 dark:text-white"
                 />
@@ -4262,63 +4337,7 @@ This example shows how to implement the component using CSS Modules.
     }
   }
 
-  &[data-popup-open] {
-    background-color: oklch(97% 0 0deg);
-
-    @media (prefers-color-scheme: dark) {
-      background-color: oklch(26.9% 0 0deg);
-    }
-  }
-
-  &:focus-visible {
-    outline: 2px solid oklch(14.5% 0 0deg);
-    outline-offset: -1px;
-
-    @media (prefers-color-scheme: dark) {
-      outline-color: white;
-    }
-  }
-}
-
-.Trigger {
-  box-sizing: border-box;
-  display: flex;
-  align-items: center;
-  justify-content: space-between;
-  gap: 0.75rem;
-  height: 2.5rem;
-  padding-left: 0.875rem;
-  padding-right: 0.75rem;
-  margin: 0;
-  outline: 0;
-  border: 1px solid oklch(14.5% 0 0deg);
-  font-family: inherit;
-  font-size: 1rem;
-  line-height: 1.5rem;
-  color: oklch(14.5% 0 0deg);
-  cursor: default;
-  -webkit-user-select: none;
-  user-select: none;
-  min-width: 9rem;
-  background-color: white;
-
-  @media (prefers-color-scheme: dark) {
-    border: 1px solid white;
-    color: white;
-    background-color: oklch(14.5% 0 0deg);
-  }
-
-  @media (hover: hover) {
-    &:hover {
-      background-color: oklch(97% 0 0deg);
-
-      @media (prefers-color-scheme: dark) {
-        background-color: oklch(26.9% 0 0deg);
-      }
-    }
-  }
-
-  &[data-popup-open] {
+  &[data-pressed] {
     background-color: oklch(97% 0 0deg);
 
     @media (prefers-color-scheme: dark) {
@@ -4575,6 +4594,7 @@ export default function ExampleEmojiPicker() {
         <input
           ref={textInputRef}
           type="text"
+          aria-label="Message"
           className={styles.TextInput}
           placeholder="iMessage"
           value={textValue}
@@ -4600,7 +4620,11 @@ export default function ExampleEmojiPicker() {
           <Autocomplete.Portal>
             <Autocomplete.Positioner className={styles.Positioner} sideOffset={4} align="end">
               <Autocomplete.Popup className={styles.Popup} aria-label="Select emoji">
-                <Autocomplete.Input placeholder="Search emojis…" className={styles.Input} />
+                <Autocomplete.Input
+                  aria-label="Search emojis"
+                  placeholder="Search emojis…"
+                  className={styles.Input}
+                />
                 <div className={styles.Viewport}>
                   <Autocomplete.Empty>
                     <div className={styles.Empty}>No emojis found</div>
@@ -5259,6 +5283,31 @@ const virtualizedItems: VirtualizedItem[] = Array.from({ length: 10000 }, (_, in
 type Virtualizer = ReturnType<typeof useVirtualizer<HTMLDivElement, Element>>;
 ```
 
+#### Memoizing items
+
+Memoizing each item is a simpler alternative to virtualization for datasets up to roughly 1,000 items. Wrap each item in [`React.memo`](https://react.dev/reference/react/memo) and pass the item as a prop so unchanged items skip re-rendering. While memoization speeds up typing, it does not speed up opening; with a large enough number of items, the mount cost dominates, and virtualization becomes necessary to keep the open interaction fast on low-end devices.
+
+```tsx title="Memoizing list items"
+interface Suggestion {
+  id: string;
+  label: string;
+  description: string;
+}
+
+const SuggestionItem = React.memo(function SuggestionItem({ item }: { item: Suggestion }) {
+  return (
+    <Autocomplete.Item value={item}>
+      <span>{item.label}</span>
+      <span>{item.description}</span>
+    </Autocomplete.Item>
+  );
+});
+
+<Autocomplete.List>
+  {(item: Suggestion) => <SuggestionItem key={item.id} item={item} />}
+</Autocomplete.List>;
+```
+
 ## API reference
 
 ### Root
@@ -5283,7 +5332,7 @@ Doesn't render its own HTML element.
 | actionsRef           | `React.RefObject<Autocomplete.Root.Actions \| null>`                                                            | -        | A ref to imperative actions. `unmount`: Manually unmounts the autocomplete.&#xA;Call this after any externally controlled closing animation finishes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | filter               | `((itemValue: ItemValue, query: string, itemToString?: ((itemValue: ItemValue) => string)) => boolean) \| null` | -        | AutocompleteFilter function used to match items vs input query.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | filteredItems        | `any[] \| Group[]`                                                                                              | -        | Filtered items to display in the list.&#xA;When provided, the list will use these items instead of filtering the `items` prop internally.&#xA;Use when you want to control filtering logic externally with the `useFilter()` hook.                                                                                                                                                                                                                                                                                                                                                                                                 |
-| form                 | `string`                                                                                                        | -        | Identifies the form that owns the internal input.&#xA;Useful when the combobox is rendered outside the form.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| form                 | `string`                                                                                                        | -        | Identifies the form that owns the internal input.&#xA;Useful when the autocomplete is rendered outside the form.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | grid                 | `boolean`                                                                                                       | `false`  | Whether list items are presented in a grid layout.&#xA;When enabled, arrow keys navigate across rows and columns inferred from DOM rows.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | inline               | `boolean`                                                                                                       | `false`  | Whether the list is rendered inline without using the component's own popup. Specify `open` unconditionally in conjunction with this prop so the list is considered&#xA;visible: `<Autocomplete.Root inline open>`                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | itemToStringValue    | `((itemValue: ItemValue) => string)`                                                                            | -        | When the item values are objects (`<Autocomplete.Item value={object}>`), this function converts the object value to a string representation for both display in the input and form submission.&#xA;If the shape of the object is `{ value, label }`, the label will be used automatically without needing to specify this prop.                                                                                                                                                                                                                                                                                                    |
@@ -5291,7 +5340,7 @@ Doesn't render its own HTML element.
 | limit                | `number`                                                                                                        | `-1`     | The maximum number of items to display in the list.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | locale               | `Intl.LocalesArgument`                                                                                          | -        | The locale to use for string comparison.&#xA;Defaults to the user's runtime locale.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | loopFocus            | `boolean`                                                                                                       | `true`   | Whether to loop keyboard focus back to the input when the end of the list is reached while using the arrow keys. The first item can then be reached by pressing ArrowDown again from the input, or the last item can be reached by pressing ArrowUp from the input.&#xA;The input is always included in the focus loop per [ARIA Authoring Practices](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/).&#xA;When disabled, focus does not move when on the last element and the user presses ArrowDown, or when on the first element and the user presses ArrowUp.                                                              |
-| modal                | `boolean`                                                                                                       | `false`  | Determines if the popup enters a modal state when open. `true`: user interaction is limited to the popup: document page scroll is locked and pointer interactions on outside elements are disabled.`false`: user interaction with the rest of the document is allowed.                                                                                                                                                                                                                                                                                                                                                             |
+| modal                | `boolean`                                                                                                       | `false`  | Determines if the popup enters a modal state when open. `true`: user interaction is limited to the popup: document page scroll is locked and pointer interactions on outside elements are disabled.`false`: user interaction with the rest of the document is allowed. On touch devices, a `true` modal blocks outside taps but leaves the page scrollable unless the popup spans nearly the full viewport width, matching native iOS behavior.                                                                                                                                                                                    |
 | mode                 | `'list' \| 'both' \| 'inline' \| 'none'`                                                                        | `'list'` | Controls how the autocomplete behaves with respect to list filtering and inline autocompletion. `list` (default): items are dynamically filtered based on the input value. The input value does not change based on the active item.`both`: items are dynamically filtered based on the input value, which will temporarily change based on the active item (inline autocompletion).`inline`: items are static (not filtered), and the input value will temporarily change based on the active item (inline autocompletion).`none`: items are static (not filtered), and the input value will not change based on the active item. |
 | onItemHighlighted    | `((highlightedValue: ItemValue \| undefined, eventDetails: Autocomplete.Root.HighlightEventDetails) => void)`   | -        | Callback fired when an item is highlighted or unhighlighted.&#xA;Receives the highlighted item value (or `undefined` if no item is highlighted) and event details with a `reason` property describing why the highlight changed.&#xA;The `reason` can be: `'keyboard'`: the highlight changed due to keyboard navigation.`'pointer'`: the highlight changed due to pointer hovering.`'none'`: the highlight changed programmatically.                                                                                                                                                                                              |
 | onOpenChangeComplete | `((open: boolean) => void)`                                                                                     | -        | Event handler called after any animations complete when the popup is opened or closed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -5326,6 +5375,7 @@ type AutocompleteRootActions = { unmount: () => void };
 ```typescript
 type AutocompleteRootChangeEventReason =
   | 'trigger-press'
+  | 'input-press'
   | 'outside-press'
   | 'item-press'
   | 'close-press'
@@ -5336,6 +5386,7 @@ type AutocompleteRootChangeEventReason =
   | 'input-clear'
   | 'clear-press'
   | 'chip-remove-press'
+  | 'cancel-open'
   | 'none';
 ```
 
@@ -5345,6 +5396,7 @@ type AutocompleteRootChangeEventReason =
 type AutocompleteRootChangeEventDetails = (
   | { reason: 'none'; event: Event }
   | { reason: 'trigger-press'; event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent }
+  | { reason: 'input-press'; event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent }
   | { reason: 'outside-press'; event: MouseEvent | PointerEvent | TouchEvent }
   | { reason: 'item-press'; event: MouseEvent | PointerEvent | KeyboardEvent }
   | { reason: 'close-press'; event: MouseEvent | PointerEvent | KeyboardEvent }
@@ -5355,6 +5407,7 @@ type AutocompleteRootChangeEventDetails = (
   | { reason: 'input-clear'; event: Event | FocusEvent | InputEvent }
   | { reason: 'clear-press'; event: MouseEvent | PointerEvent | KeyboardEvent }
   | { reason: 'chip-remove-press'; event: MouseEvent | PointerEvent | KeyboardEvent }
+  | { reason: 'cancel-open'; event: MouseEvent }
 ) & {
   /** Cancels Base UI from handling the event. */
   cancel: () => void;
@@ -5576,7 +5629,7 @@ Renders a `<button>` element.
 | data-popup-open     | -    | Present when the corresponding popup is open. |
 | data-disabled       | -    | Present when the button is disabled.          |
 | data-visible        | -    | Present when the clear button is visible.     |
-| data-starting-style | -    | Present when the button is animating in.      |
+| data-starting-style | -    | Present when the button begins animating in.  |
 | data-ending-style   | -    | Present when the button is animating out.     |
 
 ### Clear.Props
@@ -5666,12 +5719,12 @@ Renders a `<div>` element.
 
 **Backdrop Data Attributes:**
 
-| Attribute           | Type | Description                              |
-| :------------------ | :--- | :--------------------------------------- |
-| data-open           | -    | Present when the popup is open.          |
-| data-closed         | -    | Present when the popup is closed.        |
-| data-starting-style | -    | Present when the popup is animating in.  |
-| data-ending-style   | -    | Present when the popup is animating out. |
+| Attribute           | Type | Description                                 |
+| :------------------ | :--- | :------------------------------------------ |
+| data-open           | -    | Present when the popup is open.             |
+| data-closed         | -    | Present when the popup is closed.           |
+| data-starting-style | -    | Present when the popup begins animating in. |
+| data-ending-style   | -    | Present when the popup is animating out.    |
 
 ### Backdrop.Props
 
@@ -5812,7 +5865,7 @@ Renders a `<div>` element.
 | data-empty          | -                                                                          | Present when the items list is empty.                                 |
 | data-instant        | `'click' \| 'dismiss'`                                                     | Present if animations should be instant.                              |
 | data-side           | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | Indicates which side the popup is positioned relative to the trigger. |
-| data-starting-style | -                                                                          | Present when the popup is animating in.                               |
+| data-starting-style | -                                                                          | Present when the popup begins animating in.                           |
 | data-ending-style   | -                                                                          | Present when the popup is animating out.                              |
 
 ### Popup.Props
@@ -5987,17 +6040,17 @@ type AutocompleteGroupLabelState = {};
 
 ### Separator
 
-A separator element accessible to screen readers.
+A visual separator between items or groups.
 Renders a `<div>` element.
 
 **Separator Props:**
 
-| Prop        | Type                                                                                   | Default        | Description                                                                                                                                                                                   |
-| :---------- | :------------------------------------------------------------------------------------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| orientation | `Orientation`                                                                          | `'horizontal'` | The orientation of the separator.                                                                                                                                                             |
-| className   | `string \| ((state: SeparatorState) => string \| undefined)`                           | -              | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                      |
-| style       | `React.CSSProperties \| ((state: SeparatorState) => React.CSSProperties \| undefined)` | -              | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                   |
-| render      | `ReactElement \| ((props: HTMLProps, state: SeparatorState) => ReactElement)`          | -              | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
+| Prop        | Type                                                                                                 | Default        | Description                                                                                                                                                                                   |
+| :---------- | :--------------------------------------------------------------------------------------------------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| orientation | `Orientation`                                                                                        | `'horizontal'` | The orientation of the separator.                                                                                                                                                             |
+| className   | `string \| ((state: Autocomplete.Separator.State) => string \| undefined)`                           | -              | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                      |
+| style       | `React.CSSProperties \| ((state: Autocomplete.Separator.State) => React.CSSProperties \| undefined)` | -              | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                   |
+| render      | `ReactElement \| ((props: HTMLProps, state: Autocomplete.Separator.State) => ReactElement)`          | -              | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
 
 ### Separator.Props
 
@@ -6292,7 +6345,7 @@ type Orientation = 'horizontal' | 'vertical';
 - `Autocomplete.Separator`: `Autocomplete.Separator`, `Autocomplete.Separator.Props`, `Autocomplete.Separator.State`
 - `Autocomplete.useFilter`
 - `Autocomplete.useFilteredItems`
-- `Default`: `AutocompleteInputProps`, `AutocompleteInputState`, `AutocompleteIconProps`, `AutocompleteIconState`, `AutocompleteClearProps`, `AutocompleteClearState`, `AutocompletePopupProps`, `AutocompletePopupState`, `AutocompletePositionerProps`, `AutocompletePositionerState`, `AutocompleteListProps`, `AutocompleteListState`, `AutocompleteRowProps`, `AutocompleteRowState`, `AutocompleteArrowProps`, `AutocompleteArrowState`, `AutocompleteBackdropProps`, `AutocompleteBackdropState`, `AutocompletePortalProps`, `AutocompletePortalState`, `AutocompleteGroupProps`, `AutocompleteGroupState`, `AutocompleteGroupLabelProps`, `AutocompleteGroupLabelState`, `AutocompleteEmptyProps`, `AutocompleteEmptyState`, `AutocompleteStatusProps`, `AutocompleteStatusState`, `AutocompleteCollectionState`, `AutocompleteCollectionProps`, `AutocompleteFilter`, `AutocompleteFilterOptions`, `AutocompleteRootState`, `AutocompleteRootActions`, `AutocompleteRootChangeEventReason`, `AutocompleteRootChangeEventDetails`, `AutocompleteRootHighlightEventReason`, `AutocompleteRootHighlightEventDetails`, `AutocompleteRootProps`, `AutocompleteTriggerState`, `AutocompleteTriggerProps`, `AutocompleteInputGroupState`, `AutocompleteInputGroupProps`, `AutocompleteItemState`, `AutocompleteItemProps`, `AutocompleteValueState`, `AutocompleteValueProps`
+- `Default`: `AutocompleteSeparatorProps`, `AutocompleteSeparatorState`, `AutocompleteInputProps`, `AutocompleteInputState`, `AutocompleteIconProps`, `AutocompleteIconState`, `AutocompleteClearProps`, `AutocompleteClearState`, `AutocompletePopupProps`, `AutocompletePopupState`, `AutocompletePositionerProps`, `AutocompletePositionerState`, `AutocompleteListProps`, `AutocompleteListState`, `AutocompleteRowProps`, `AutocompleteRowState`, `AutocompleteArrowProps`, `AutocompleteArrowState`, `AutocompleteBackdropProps`, `AutocompleteBackdropState`, `AutocompletePortalProps`, `AutocompletePortalState`, `AutocompleteGroupProps`, `AutocompleteGroupState`, `AutocompleteGroupLabelProps`, `AutocompleteGroupLabelState`, `AutocompleteEmptyProps`, `AutocompleteEmptyState`, `AutocompleteStatusProps`, `AutocompleteStatusState`, `AutocompleteCollectionState`, `AutocompleteCollectionProps`, `AutocompleteFilter`, `AutocompleteFilterOptions`, `AutocompleteRootState`, `AutocompleteRootActions`, `AutocompleteRootChangeEventReason`, `AutocompleteRootChangeEventDetails`, `AutocompleteRootHighlightEventReason`, `AutocompleteRootHighlightEventDetails`, `AutocompleteRootProps`, `AutocompleteTriggerState`, `AutocompleteTriggerProps`, `AutocompleteInputGroupState`, `AutocompleteInputGroupProps`, `AutocompleteItemState`, `AutocompleteItemProps`, `AutocompleteValueState`, `AutocompleteValueProps`
 
 ## Canonical Types
 
@@ -6343,6 +6396,8 @@ Maps `Canonical`: `Alias` — Use Canonical when its namespace is already import
 - `Autocomplete.Collection.Props`: `AutocompleteCollectionProps`
 - `Autocomplete.Empty.State`: `AutocompleteEmptyState`
 - `Autocomplete.Empty.Props`: `AutocompleteEmptyProps`
+- `Autocomplete.Separator.Props`: `AutocompleteSeparatorProps`
+- `Autocomplete.Separator.State`: `AutocompleteSeparatorState`
 
 ## useFilter
 

package/docs/react/components/avatar.md

@@ -162,19 +162,19 @@ Renders an `<img>` element.
 
 **Image Props:**
 
-| Prop                  | Type                                                                                       | Default | Description                                                                                                                                                                                   |
-| :-------------------- | :----------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| onLoadingStatusChange | `((status: ImageLoadingStatus) => void)`                                                   | -       | Callback fired when the loading status changes.                                                                                                                                               |
-| className             | `string \| ((state: Avatar.Image.State) => string \| undefined)`                           | -       | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                      |
-| style                 | `React.CSSProperties \| ((state: Avatar.Image.State) => React.CSSProperties \| undefined)` | -       | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                   |
-| render                | `ReactElement \| ((props: HTMLProps, state: Avatar.Image.State) => ReactElement)`          | -       | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
+| Prop                  | Type                                                                                                                                                         | Default | Description                                                                                                                                                                                   |
+| :-------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| onLoadingStatusChange | `((status: ImageLoadingStatus) => void)`                                                                                                                     | -       | Callback fired when the loading status changes.                                                                                                                                               |
+| className             | `string \| ((state: Avatar.Image.State) => string \| undefined)`                                                                                             | -       | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                      |
+| style                 | `React.CSSProperties \| ((state: Avatar.Image.State) => React.CSSProperties \| undefined)`                                                                   | -       | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                   |
+| render                | `ReactElement \| ((props: React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, state: Avatar.Image.State) => ReactElement)` | -       | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
 
 **Image Data Attributes:**
 
-| Attribute           | Type | Description                              |
-| :------------------ | :--- | :--------------------------------------- |
-| data-starting-style | -    | Present when the image is animating in.  |
-| data-ending-style   | -    | Present when the image is animating out. |
+| Attribute           | Type | Description                                 |
+| :------------------ | :--- | :------------------------------------------ |
+| data-starting-style | -    | Present when the image begins animating in. |
+| data-ending-style   | -    | Present when the image is animating out.    |
 
 ### Image.Props
 
@@ -200,7 +200,7 @@ Renders a `<span>` element.
 
 | Prop      | Type                                                                                          | Default | Description                                                                                                                                                                                   |
 | :-------- | :-------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| delay     | `number`                                                                                      | -       | How long to wait before showing the fallback. Specified in milliseconds.                                                                                                                      |
+| delay     | `number`                                                                                      | `0`     | How long to wait before showing the fallback. Specified in milliseconds.                                                                                                                      |
 | className | `string \| ((state: Avatar.Fallback.State) => string \| undefined)`                           | -       | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                      |
 | style     | `React.CSSProperties \| ((state: Avatar.Fallback.State) => React.CSSProperties \| undefined)` | -       | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                   |
 | render    | `ReactElement \| ((props: HTMLProps, state: Avatar.Fallback.State) => ReactElement)`          | -       | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
@@ -243,3 +243,7 @@ Maps `Canonical`: `Alias` — Use Canonical when its namespace is already import
 - `Avatar.Image.Props`: `AvatarImageProps`
 - `Avatar.Fallback.State`: `AvatarFallbackState`
 - `Avatar.Fallback.Props`: `AvatarFallbackProps`
+
+[//]: # '@exclude-table-of-contents'
+
+## Additional types

package/docs/react/components/checkbox.md

@@ -249,26 +249,26 @@ Renders a `<span>` element and a hidden `<input>` beside.
 
 **Root Props:**
 
-| Prop            | Type                                                                                        | Default     | Description                                                                                                                                                                                   |
-| :-------------- | :------------------------------------------------------------------------------------------ | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| name            | `string`                                                                                    | `undefined` | Identifies the field when a form is submitted.                                                                                                                                                |
-| defaultChecked  | `boolean`                                                                                   | `false`     | Whether the checkbox is initially ticked. To render a controlled checkbox, use the `checked` prop instead.                                                                                    |
-| checked         | `boolean`                                                                                   | `undefined` | Whether the checkbox is currently ticked. To render an uncontrolled checkbox, use the `defaultChecked` prop instead.                                                                          |
-| onCheckedChange | `((checked: boolean, eventDetails: Checkbox.Root.ChangeEventDetails) => void)`              | -           | Event handler called when the checkbox is ticked or unticked.                                                                                                                                 |
-| indeterminate   | `boolean`                                                                                   | `false`     | Whether the checkbox is in a mixed state: neither ticked, nor unticked.                                                                                                                       |
-| value           | `string`                                                                                    | -           | The value of the selected checkbox.                                                                                                                                                           |
-| form            | `string`                                                                                    | -           | Identifies the form that owns the hidden input.&#xA;Useful when the checkbox is rendered outside the form.                                                                                    |
-| nativeButton    | `boolean`                                                                                   | `false`     | Whether the component renders a native `<button>` element when replacing it&#xA;via the `render` prop.&#xA;Set to `true` if the rendered element is a native button.                          |
-| parent          | `boolean`                                                                                   | `false`     | Whether the checkbox controls a group of child checkboxes. Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group).                                           |
-| uncheckedValue  | `string`                                                                                    | -           | The value submitted with the form when the checkbox is unchecked.&#xA;By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.                            |
-| disabled        | `boolean`                                                                                   | `false`     | Whether the component should ignore user interaction.                                                                                                                                         |
-| readOnly        | `boolean`                                                                                   | `false`     | Whether the user should be unable to tick or untick the checkbox.                                                                                                                             |
-| required        | `boolean`                                                                                   | `false`     | Whether the user must tick the checkbox before submitting a form.                                                                                                                             |
-| inputRef        | `React.Ref<HTMLInputElement>`                                                               | -           | A ref to access the hidden `<input>` element.                                                                                                                                                 |
-| id              | `string`                                                                                    | -           | The id of the input element.                                                                                                                                                                  |
-| className       | `string \| ((state: Checkbox.Root.State) => string \| undefined)`                           | -           | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                      |
-| style           | `React.CSSProperties \| ((state: Checkbox.Root.State) => React.CSSProperties \| undefined)` | -           | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                   |
-| render          | `ReactElement \| ((props: HTMLProps, state: Checkbox.Root.State) => ReactElement)`          | -           | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
+| Prop            | Type                                                                                        | Default     | Description                                                                                                                                                                                                                                                      |
+| :-------------- | :------------------------------------------------------------------------------------------ | :---------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| name            | `string`                                                                                    | `undefined` | Identifies the field when a form is submitted.                                                                                                                                                                                                                   |
+| defaultChecked  | `boolean`                                                                                   | `false`     | Whether the checkbox is initially ticked. To render a controlled checkbox, use the `checked` prop instead.                                                                                                                                                       |
+| checked         | `boolean`                                                                                   | `undefined` | Whether the checkbox is currently ticked. To render an uncontrolled checkbox, use the `defaultChecked` prop instead.                                                                                                                                             |
+| onCheckedChange | `((checked: boolean, eventDetails: Checkbox.Root.ChangeEventDetails) => void)`              | -           | Event handler called when the checkbox is ticked or unticked.                                                                                                                                                                                                    |
+| indeterminate   | `boolean`                                                                                   | `false`     | Whether the checkbox is in a mixed state: neither ticked, nor unticked.                                                                                                                                                                                          |
+| value           | `string`                                                                                    | -           | The checkbox's value. Identifies it within a [Checkbox Group](https://base-ui.com/react/components/checkbox-group), falling back to `name` when omitted.&#xA;When submitting a form, a checked box submits `value`; with no `value`, it submits the native "on". |
+| form            | `string`                                                                                    | -           | Identifies the form that owns the hidden input.&#xA;Useful when the checkbox is rendered outside the form.                                                                                                                                                       |
+| nativeButton    | `boolean`                                                                                   | `false`     | Whether the component renders a native `<button>` element when replacing it&#xA;via the `render` prop.&#xA;Set to `true` if the rendered element is a native button.                                                                                             |
+| parent          | `boolean`                                                                                   | `false`     | Whether the checkbox controls a group of child checkboxes. Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group).                                                                                                              |
+| uncheckedValue  | `string`                                                                                    | -           | The value submitted with the form when the checkbox is unchecked.&#xA;By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.                                                                                               |
+| disabled        | `boolean`                                                                                   | `false`     | Whether the component should ignore user interaction.                                                                                                                                                                                                            |
+| readOnly        | `boolean`                                                                                   | `false`     | Whether the user should be unable to tick or untick the checkbox.                                                                                                                                                                                                |
+| required        | `boolean`                                                                                   | `false`     | Whether the user must tick the checkbox before submitting a form.                                                                                                                                                                                                |
+| inputRef        | `React.Ref<HTMLInputElement>`                                                               | -           | A ref to access the hidden `<input>` element.                                                                                                                                                                                                                    |
+| id              | `string`                                                                                    | -           | The id of the input element.                                                                                                                                                                                                                                     |
+| className       | `string \| ((state: Checkbox.Root.State) => string \| undefined)`                           | -           | CSS class applied to the element, or a function that&#xA;returns a class based on the component's state.                                                                                                                                                         |
+| style           | `React.CSSProperties \| ((state: Checkbox.Root.State) => React.CSSProperties \| undefined)` | -           | Style applied to the element, or a function that&#xA;returns a style object based on the component's state.                                                                                                                                                      |
+| render          | `ReactElement \| ((props: HTMLProps, state: Checkbox.Root.State) => ReactElement)`          | -           | Allows you to replace the component's HTML element&#xA;with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.                                                                    |
 
 **Root Data Attributes:**
 
@@ -375,7 +375,7 @@ Renders a `<span>` element.
 | data-filled         | -    | Present when the checkbox is checked (when wrapped in Field.Root).             |
 | data-focused        | -    | Present when the checkbox is focused (when wrapped in Field.Root).             |
 | data-indeterminate  | -    | Present when the checkbox is in an indeterminate state.                        |
-| data-starting-style | -    | Present when the checkbox indicator is animating in.                           |
+| data-starting-style | -    | Present when the checkbox indicator begins animating in.                       |
 | data-ending-style   | -    | Present when the checkbox indicator is animating out.                          |
 
 ### Indicator.Props