Collection

Renders a simple wrapper for collection items. It accepts a collection store through the store prop and provides context for CollectionItem components.

Code examples

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

Optional Props

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, 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.

Check out the Composition guide for more details.

`store`

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

Object returned by the useCollectionStore hook. If not provided, the closest CollectionProvider component's context will be used.

Collection

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`