Ariakit
/

Code examples

<MenuProvider defaultValues={{ apple: true, orange: false }}>
<Menu>
Apple
<MenuItemCheckbox name="orange">
Orange
</Menu>

Optional Props


checked

boolean | undefined

Determines if the checkmark should be rendered. This value is automatically derived from the context when it exists. Manually setting this prop will supersede the derived value.

Live examples


render

RenderProp<React.HTMLAttributes<any> & React.RefAttributes<any>> | 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

Object returned by the useMenuStore hook.

Follow updates

Join 1,000+ subscribers and receive monthly updates with the latest improvements on API Reference.

Read latest issue

No Spam. Unsubscribe at any time.