Skip to content

NavigationMenu ​

Overview ​

The root provider for a navigation menu.

Theme entry: NavigationMenu

Props ​

NameTypeRequiredDefaultDescription
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.
modelValuestringundefinedThe controlled value of the active menu item.
defaultValuestringundefinedThe value of the menu item that should be active when initially rendered.
dirstringundefinedThe reading direction of the menu.
orientationstringundefinedThe orientation of the menu.
delayDurationnumberundefinedThe duration in ms from when the pointer enters the trigger until the tooltip opens.
skipDelayDurationnumberundefinedHow much time a user has to enter another trigger without incurring a delay again.
disableClickTriggerbooleanundefinedWhen true, menu cannot be opened by clicking on trigger.
disableHoverTriggerbooleanundefinedWhen true, menu cannot be opened by hovering on trigger.
disablePointerLeaveClosebooleanundefinedWhen true, menu will not close during pointer leave event.
unmountOnHidebooleanundefinedWhen true, the element will be unmounted on closed state.
viewportbooleantrueWhen true, renders a viewport element below the menu list.

Slots ​

default ​

Scoped slot.

Events ​

NameDescription
update:modelValueEmitted when the value changes.

Full event reference

Source ​

client/lib/navigation/menu/NavigationMenu.vue