Skip to content

MenubarCheckboxItem

Overview

A checkable item within a menubar menu.

Theme entry: MenubarCheckboxItem

Props

NameTypeRequiredDefaultDescription
iconOverrideObjectnullA partial icon registry ({ [componentName]: { [iconName]: { component, props } } }) merged with inherited and default icon entries; scopes icon overrides to this component and its descendants.
themeOverrideString|Object|ArraynullA partial theme object merged with the component's default theme; accepts a class string, class array, or theme object.
classimport('vue').HTMLAttributes['class']undefinedAdditional CSS classes to apply to the root element.
asstring|objectundefinedThe element or component to render as.
asChildbooleanfalseWhen true, merges props onto the child element instead of rendering a wrapper.
disabledbooleanundefinedWhen true, prevents the user from interacting with the item.
textValuestringundefinedOptional text used for typeahead purposes.
modelValueboolean|stringundefinedThe controlled checked state of the item.

Slots

default

Slot.

Events

NameDescription
selectEmitted when an item is selected.
update:modelValueEmitted when the value changes.

Full event reference

Source

client/lib/navigation/menubar/MenubarCheckboxItem.vue

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2