Skip to content

ContextMenuCheckboxItem ​

Overview ​

A checkable item within a context menu.

Theme entry: ContextMenuCheckboxItem

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.
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
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/context-menu/ContextMenuCheckboxItem.vue