CompositeTypeahead

Renders a component that adds typeahead functionality to composite components.

When the typeahead prop is enabled, which it is by default, hitting printable character keys will move focus to the next composite item that begins with the input characters.

Code examples

<CompositeProvider>
  <Composite render={<CompositeTypeahead />}>
    <CompositeItem>Item 1</CompositeItem>
    <CompositeItem>Item 2</CompositeItem>
  </Composite>
</CompositeProvider>
<CompositeProvider>
  <Composite render={<CompositeTypeahead />}>
    <CompositeItem>Item 1</CompositeItem>
    <CompositeItem>Item 2</CompositeItem>
  </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.

`typeahead`

boolean | undefined = true
boolean | undefined = true

When enabled, pressing printable character keys will move focus to the next composite item that starts with the entered characters.

CompositeTypeahead

Code examples

Optional Props

render

store

typeahead

Stay tuned

`render`

`store`

`typeahead`