CompositeGroupLabel

Composite

Renders a label in a composite group. This component must be wrapped with CompositeGroup so the aria-labelledby prop is properly set on the group element.

Code examples

<CompositeProvider>
  <Composite>
    <CompositeGroup>
      <CompositeGroupLabel>Label</CompositeGroupLabel>
      <CompositeItem>Item 1</CompositeItem>
      <CompositeItem>Item 2</CompositeItem>
    </CompositeGroup>
  </Composite>
</CompositeProvider>
<CompositeProvider>
  <Composite>
    <CompositeGroup>
      <CompositeGroupLabel>Label</CompositeGroupLabel>
      <CompositeItem>Item 1</CompositeItem>
      <CompositeItem>Item 2</CompositeItem>
    </CompositeGroup>
  </Composite>
</CompositeProvider>

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`

CompositeStore<CompositeStoreItem> | undefined
CompositeStore<CompositeStoreItem> | undefined

Object returned by the useCompositeStore hook. If not provided, the closest Composite or CompositeProvider components' context will be used.

CompositeGroupLabel

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`