UiListMenuItem

A row inside a list menu.

Contents

A list row with an icon, a label, an optional hint and a trailing area. It can behave as a link (with a chevron), a toggle row, or a select row, and supports a destructive style.

Examples

Row types

A clickable row (with chevron), a toggle row (tapping anywhere toggles), a row with a hint, and a destructive row.

Profile
Notifications
AboutVersion 1.2.0
Sign out
<UiListMenu class="max-w-sm">
  <UiListMenuItem icon="mdi:account-outline" clickable>Profile</UiListMenuItem>
  <UiListMenuItem icon="mdi:bell-outline" :toggle="state.notify" @update:toggle="state.notify = $event">
    Notifications
    <template #suffix><UiToggle :model-value="state.notify" readonly /></template>
  </UiListMenuItem>
  <UiListMenuItem icon="mdi:information-outline" hint="Version 1.2.0">About</UiListMenuItem>
  <UiListMenuItem icon="mdi:logout" danger clickable :chevron="false">Sign out</UiListMenuItem>
</UiListMenu>

Suffix content

The #suffix slot holds any trailing control — a badge, a value, a select.

Storage
80% full
Theme
System
<UiListMenu class="max-w-sm">
  <UiListMenuItem icon="mdi:cloud-outline" clickable>
    Storage
    <template #suffix><UiBadge color="amber" size="xs">80% full</UiBadge></template>
  </UiListMenuItem>
  <UiListMenuItem icon="mdi:palette-outline" clickable>
    Theme
    <template #suffix><span class="text-xs text-gray-400">System</span></template>
  </UiListMenuItem>
</UiListMenu>

Props

NameTypeDefaultDescription
iconstring''Leading MDI icon.
iconClassstring''Class for the icon.
clickablebooleanfalseMake the row activate on click.
togglebooleanundefinedRender a toggle row bound to this value.
selectRefobjectundefinedA UiSelect ref to open when the row is tapped.
chevronbooleantrueShow the trailing chevron.
dangerbooleanfalseDestructive styling.
disabledbooleanfalseDisables the row.
hintstring''Secondary text.
sizestring'md'Row size. mdsm

Events

EventPayloadDescription
clickvoidEmitted when a clickable row is activated.
update:togglebooleanEmitted with the new value when a toggle row is tapped.

Slots

SlotDescription
defaultLabel text.
suffixTrailing content (toggle, select, badge, …).