Skip to content

DropdownItemCheckbox

A menu item with a checkbox state for use inside DropdownMenu. Toggling the item does not close the menu, so users can check multiple options in one interaction.

Basic usage

badge=true, autoSave=false, compact=false

Tailwind v4
vue
<script setup>
import { ref } from 'vue'
const showBadge = ref(true)
const autoSave = ref(false)
</script>

<template>
  <DropdownMenu>
    <template #trigger>
      <Button variant="secondary">View options</Button>
    </template>
    <DropdownItemCheckbox v-model="showBadge">Show badge count</DropdownItemCheckbox>
    <DropdownItemCheckbox v-model="autoSave">Auto-save changes</DropdownItemCheckbox>
  </DropdownMenu>
</template>

With description

Tailwind v4
vue
<DropdownItemCheckbox v-model="showBadge" description="Show unread count on the icon">
  Notification badge
</DropdownItemCheckbox>

Disabled

Tailwind v4
vue
<DropdownItemCheckbox :model-value="true" disabled>Always-on feature</DropdownItemCheckbox>

Props

PropTypeDefaultDescription
modelValuebooleanfalseWhether the item is checked
disabledbooleanfalsePrevents toggling and dims the item
descriptionstringSecondary text shown below the label

Emits

EventPayloadDescription
update:modelValuebooleanNew checked state after toggle

Slots

SlotDescription
defaultItem label text

Private — Jetpack Labs internal use only