useCompositeStore

Creates a composite store to control the state of Composite components.

Code examples

const composite = useCompositeStore();

<Composite store={composite}>
  <CompositeItem>Item</CompositeItem>
  <CompositeItem>Item</CompositeItem>
  <CompositeItem>Item</CompositeItem>
</Composite>
const composite = useCompositeStore();

<Composite store={composite}>
  <CompositeItem>Item</CompositeItem>
  <CompositeItem>Item</CompositeItem>
  <CompositeItem>Item</CompositeItem>
</Composite>

Optional Props

`activeId`

string | null | undefined
string | null | undefined

The current active item id. The active item is the element within the composite widget that has either DOM or virtual focus (in case virtualFocus is enabled).

null represents the base composite element (the one with a composite role⁠). Users will be able to navigate out of it using arrow keys.
If activeId is initially set to null, the includesBaseElement prop will also default to true, which means the base composite element itself will have focus and users will be able to navigate to it using arrow keys.

Live examples

Combobox with TabsOrganizing Combobox with Tab components that support mouse, keyboard, and screen reader interactions. The UI remains responsive by using React.startTransition.

`defaultActiveId`

string | null | undefined
string | null | undefined

The composite item id that should be active by default when the composite widget is rendered. If null, the composite element itself will have focus and users will be able to navigate to it using arrow keys. If undefined, the first enabled item will be focused.

`defaultItems`

T[] | undefined = []
T[] | undefined = []

The defaut value for the items state.

`focusLoop`

boolean | Orientation = false
boolean | Orientation = false

Determines how the focus behaves when the user reaches the end of the composite widget.

On one-dimensional composite widgets:

true loops from the last item to the first item and vice-versa.
horizontal loops only if orientation is horizontal or not set.
vertical loops only if orientation is vertical or not set.
If includesBaseElement is set to true (or activeId is initially set to null), the composite element will be focused in between the last and first items.

On two-dimensional composite widgets (when using CompositeRow or explicitly passing a rowId prop to composite items):

true loops from the last row/column item to the first item in the same row/column and vice-versa. If it's the last item in the last row, it moves to the first item in the first row and vice-versa.
horizontal loops only from the last row item to the first item in the same row.
vertical loops only from the last column item to the first item in the column row.
If includesBaseElement is set to true (or activeId is initially set to null), vertical loop will have no effect as moving down from the last row or up from the first row will focus on the composite element.
If focusWrap matches the value of focusLoop, it'll wrap between the last item in the last row or column and the first item in the first row or column and vice-versa.

Live examples

Command MenuCombining Dialog and Combobox to enable users to search a command list in a Raycast-style modal.

`focusShift`

boolean = false
boolean = false

Works only on two-dimensional composite widgets.

If enabled, moving up or down when there's no next item or when the next item is disabled will shift to the item right before it.

`focusWrap`

boolean | Orientation = false
boolean | Orientation = false

Works only on two-dimensional composite widgets.

If enabled, moving to the next item from the last one in a row or column will focus on the first item in the next row or column and vice-versa.

true wraps between rows and columns.
horizontal wraps only between rows.
vertical wraps only between columns.
If focusLoop matches the value of focusWrap, it'll wrap between the last item in the last row or column and the first item in the first row or column and vice-versa.

`id`

string
string

The ID of the composite store is used to reference elements within the composite widget before hydration. If not provided, a random ID will be generated.

`includesBaseElement`

boolean = false
boolean = false

Indicates if the composite base element (the one with a composite role⁠) should be part of the focus order when navigating with arrow keys. In other words, moving to the previous element when the first item is in focus will focus on the composite element itself. The same applies to the last item when moving to the next element.

Live examples

Submenu with ComboboxNesting Notion-style dropdown menus with search & autocomplete features by combining Menu with Combobox.

Command MenuCombining Dialog and Combobox to enable users to search a command list in a Raycast-style modal.

`items`

T[]
T[]

Lists all items along with their metadata. This state is automatically updated when an item is registered or unregistered using the registerItem function.

`orientation`

Orientation = "both"
Orientation = "both"

Defines the orientation of the composite widget. If the composite has a single row or column (one-dimensional), the orientation value determines which arrow keys can be used to move focus:

both: all arrow keys work.
horizontal: only left and right arrow keys work.
vertical: only up and down arrow keys work.

It doesn't have any effect on two-dimensional composites.

`rtl`

boolean = false
boolean = false

Determines how the next and previous functions will behave. If rtl is set to true, they will be inverted.

This only affects the composite widget behavior. You still need to set dir="rtl" on HTML/CSS.

`setActiveId`

((activeId: string | null | undefined) => void) | undefined
((activeId: string | null | undefined) => void) | undefined

A callback that gets called when the activeId state changes.

`setItems`

BivariantCallback<(items: T[]) => void> | undefined
BivariantCallback<(items: T[]) => void> | undefined

A callback that gets called when the items state changes.

Code examples

const [items, setItems] = useState([]);
const collection = useCollectionStore({ items, setItems });
const [items, setItems] = useState([]);
const collection = useCollectionStore({ items, setItems });

`store`

Store<Partial<S>> | undefined
Store<Partial<S>> | undefined

Another store object that will be kept in sync with the original store.

Live examples

Navigation MenubarUsing Menubar, Menu, and Portal to create an accessible, tabbable navigation menu widget with links and menu buttons that expand on hover and focus.

`virtualFocus`

boolean = false
boolean = false

If enabled, the composite element will act as an aria-activedescendant⁠ container instead of roving tabindex⁠. DOM focus will remain on the composite element while its items receive virtual focus.

In both scenarios, the item in focus will carry the data-active-item attribute.

Live examples

Select with Combobox and TabsAbstracting Select to work alongside Combobox and Tab components, presenting a searchable, tabbed dropdown.

Return Props

`setBaseElement`

SetState<HTMLElement | null>
SetState<HTMLElement | null>

Sets the baseElement state.

`setActiveId`

SetState<string | null | undefined>
SetState<string | null | undefined>

Sets the activeId state without moving focus. If you want to move focus, use the move function instead.

Code examples

// Sets the composite element as the active item
store.setActiveId(null);
// Sets the item with id "item-1" as the active item
store.setActiveId("item-1");
// Sets the next item as the active item
store.setActiveId(store.next());
// Sets the composite element as the active item
store.setActiveId(null);
// Sets the item with id "item-1" as the active item
store.setActiveId("item-1");
// Sets the next item as the active item
store.setActiveId(store.next());

`move`

(id?: string | null | undefined) => void
(id?: string | null | undefined) => void

Moves focus to a given item id and sets it as the active item.

Passing null will focus on the composite element itself (the one with a composite role⁠). Users will be able to navigate out of it using arrow keys.
If you want to set the active item id without moving focus, use the setActiveId function instead.

Live examples

Select GridUsing Select with SelectPopover rendered with the grid role to create a bidimensional list of selectable items.

Code examples

// Moves focus to the composite element
store.move(null);
// Moves focus to the item with id "item-1"
store.move("item-1");
// Moves focus to the next item
store.move(store.next());
// Moves focus to the composite element
store.move(null);
// Moves focus to the item with id "item-1"
store.move("item-1");
// Moves focus to the next item
store.move(store.next());

`next`

{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }
{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }

Returns the id of the next enabled item based on the current activeId state. You can pass additional options to override the current state.

Code examples

const nextId = store.next();
const nextId = store.next();

`previous`

{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }
{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }

Returns the id of the previous enabled item based on the current activeId state. You can pass additional options to override the current state.

Code examples

const previousId = store.previous();
const previousId = store.previous();

`up`

{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }
{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }

Returns the id of the enabled item above based on the current activeId state. You can pass additional options to override the current state.

Code examples

const upId = store.up();
const upId = store.up();

`down`

{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }
{ (options?: NextOptions | undefined): string | null | undefined; (skip?: number | undefined): string | null | undefined; }

Returns the id of the enabled item below based on the current activeId state. You can pass additional options to override the current state.

Code examples

const downId = store.down();
const downId = store.down();

`first`

() => string | null | undefined
() => string | null | undefined

Returns the id of the first enabled item.

`last`

() => string | null | undefined
() => string | null | undefined

Returns the id of the last enabled item.

`registerItem`

BivariantCallback<(item: T) => () => void>
BivariantCallback<(item: T) => () => void>

Registers an item in the collection. This function returns a cleanup function that unregisters the item.

Code examples

const unregisterItem = store.registerItem({ id: "item-1" });
// on cleanup
unregisterItem();
const unregisterItem = store.registerItem({ id: "item-1" });
// on cleanup
unregisterItem();

`renderItem`

BivariantCallback<(item: T) => () => void>
BivariantCallback<(item: T) => () => void>

Renders an item in the collection. This function returns a cleanup function that unmounts the item.

Code examples

const unrenderItem = store.renderItem({ id: "item-1" });
// on cleanup
unrenderItem();
const unrenderItem = store.renderItem({ id: "item-1" });
// on cleanup
unrenderItem();

`item`

(id: string | null | undefined) => T | null
(id: string | null | undefined) => T | null

Gets an item by its id.

Live examples

Animated TabPanelUsing plain CSS transitions to slide in and out TabPanel components as they are expanded.

Code examples

const item = store.item("item-1");
const item = store.item("item-1");

`getState`

() => S
() => S

Returns the current store state.

`setState`

<K extends keyof S>(key: K, value: SetStateAction<S[K]>) => void
<K extends keyof S>(key: K, value: SetStateAction<S[K]>) => void

Sets a state value.

`useState`

UseState<StoreState<T>>
UseState<StoreState<T>>

Deprecated: Use useStoreState instead.

Re-renders the component when the state changes and returns the current state.

useCompositeStore

Live examples

Live examples

Live examples

Code examples

Live examples

Live examples

Code examples

Live examples

Code examples

Code examples

Code examples

Code examples

Code examples

Code examples

Code examples

Live examples

Code examples

Stay tuned