MenuItemCheck

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>
<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
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<unknown, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, 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.

Some Ariakit components detect the type of the underlying element when they mount. If the render element's type may change while the component is mounted, pass a key⁠ prop that changes with the element type so React remounts the component with the new element. Remounting resets uncontrolled state, so keep the relevant state controlled:

<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>
<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>

Check out the Composition guide for more details.

`store`

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

Object returned by the useMenuStore hook. This prop doesn't affect the checkmark. It's accepted for consistency with other Ariakit components and is not passed to the underlying element. The checked state is derived solely from the checked prop or, when it's not provided, from the closest MenuItemCheckbox or MenuItemRadio component.

MenuItemCheck

Code examples

Optional Props

checked

Live examples

render

store

Stay tuned

`checked`

`render`

`store`