MenuDescription

Renders a description in a menu. This component must be wrapped with a Menu component so the aria-describedby prop is properly set on the menu element.

Code examples

<MenuProvider>
  <Menu>
    <MenuDescription>Description</MenuDescription>
  </Menu>
</MenuProvider>
<MenuProvider>
  <Menu>
    <MenuDescription>Description</MenuDescription>
  </Menu>
</MenuProvider>

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`

MenuStore<MenuStoreValues> | undefined
MenuStore<MenuStoreValues> | undefined

Object returned by the useMenuStore hook. If not provided, the closest Menu or MenuProvider components' context will be used.

MenuDescription

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`