Ariakit
/

MenuItemCheck

Menu

Renders a checkmark icon when the checked prop is true. The icon can be overridden by providing a different one as children.

When rendered inside MenuItemCheckbox or MenuItemRadio components, the checked prop is automatically derived from the context.

Code examples

<MenuProvider defaultValues={{ apple: true, orange: false }}>

  <MenuButton>Fruits</MenuButton>

  <Menu>

    <MenuItemCheckbox name="apple">

      <MenuItemCheck />

      Apple

    </MenuItemCheckbox>

    <MenuItemCheckbox name="orange">

      <MenuItemCheck />

      Orange

    </MenuItemCheckbox>

  </Menu>

</MenuProvider>

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

Submenu with ComboboxNesting Notion-style dropdown menus with search & autocomplete features by combining Menu with Combobox.

render

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

Object returned by the useMenuStore hook.

Stay tuned

Join 1,000+ subscribers and receive monthly tips & updates on new Ariakit content.

No spam. Unsubscribe anytime. Read latest issue⁠