CollectionItem

Collection

Renders an item in a collection. The collection store can be passed explicitly through the store prop or implicitly through the parent Collection component.

Code examples

const store = useCollectionStore();
<CollectionItem store={store}>Item 1</CollectionItem>
<CollectionItem store={store}>Item 2</CollectionItem>
<CollectionItem store={store}>Item 3</CollectionItem>
const store = useCollectionStore();
<CollectionItem store={store}>Item 1</CollectionItem>
<CollectionItem store={store}>Item 2</CollectionItem>
<CollectionItem store={store}>Item 3</CollectionItem>

Optional Props

`getItem`

((props: CollectionStoreItem) => CollectionStoreItem) | undefined
((props: CollectionStoreItem) => CollectionStoreItem) | undefined

A memoized function that returns props to be passed with the item during its registration in the store.

Code examples

const getItem = useCallback((data) => ({ ...data, custom: true }), []);
<CollectionItem getItem={getItem} />
const getItem = useCallback((data) => ({ ...data, custom: true }), []);
<CollectionItem getItem={getItem} />

`id`

string | undefined
string | undefined

The unique ID of the item. This will be used to register the item in the store and for the element's id attribute. If not provided, a unique ID will be automatically generated.

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.

Tab with React RouterUsing React Router to create Tab links and tab panels controlled by the browser history, while maintaining keyboard navigation.

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

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

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined

Allows the component to be rendered as a different HTML element or React component. The value can be a React element or a function that takes in the original component props and gives back a React element with the props merged.

Some Ariakit components detect the type of the underlying element when they mount. If the render element's type may change while the component is mounted, pass a key⁠ prop that changes with the element type so React remounts the component with the new element. Remounting resets uncontrolled state, so keep the relevant state controlled:

<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>
<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>

Check out the Composition guide for more details.

`shouldRegisterItem`

boolean | undefined = true
boolean | undefined = true

Whether the item should be registered as part of the collection.

`store`

CollectionStore<CollectionStoreItem> | undefined
CollectionStore<CollectionStoreItem> | undefined

Object returned by the useCollectionStore hook. If not provided, the closest Collection or CollectionProvider components' context will be used.

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.

CollectionItem

Code examples

Optional Props

getItem

Code examples

id

Live examples

render

shouldRegisterItem

store

Live examples

Stay tuned

`getItem`

`id`

`render`

`shouldRegisterItem`

`store`