build69
build69  /  Components  /  Selection & Choice  /  ChecklistMenu

ChecklistMenu

v1.0.16Updated 19 Oct 2026

Multi-select checkbox dropdown. Search filter, "Select all" with indeterminate state, "Clear" link, "N of M selected" header, trigger count badge, optional grouping with section headings.

View source← Back to catalog

Preview

Live · 15 stories
DefaultOpen ↗
▸Why this is recommendedformmulti-selectdropdowncheckbox+4

The default, out-of-the-box ChecklistMenu.

Recommended for+14
  • ✓Column visibility menus
  • ✓Multi-facet filter dropdowns
  • ✓Bulk-action target pickers
Tags+6
formmulti-selectdropdowncheckboxfiltermenupopoverdefault
Features+4
  • Multi-select checkbox rows
  • Search filter
  • Select-all with indeterminate parent state
  • Clear-all link
  • N-of-M selected header
  • Trigger count badge
  • Optional grouping with section headings
  • Per-item icon / description / meta / disabled
  • i18n: labels prop overrides every built-in string ({token} templates); counts format via LocaleProvider
Not recommended for−2
  • ✕Single-select dropdowns (use Select)
  • ✕Free-text input (use TagInput)

Install

Ask your agent, or call the MCP tool directly. The resolved bundle is written into your project.

get_registry_item({ name: "ChecklistMenu" })

Usage

import { ChecklistMenu } from '@/components/inputs/checklist-menu';

<ChecklistMenu
  items={columns}
  values={visible}
  onValuesChange={setVisible}
  triggerLabel="Columns"
  searchable
  showSelectAll
/>

Tick variants in the left menu — each adds a tab with that variant’s real story source, the same code the preview above renders.

Props

PropTypeRequired
items

Item list (with optional group)

ChecklistMenuItem[]yes
values

Selected ids

string[]yes
onValuesChange

Selection callback

functionyes
searchable

Show search filter

boolean—
showSelectAll

Show select-all row

boolean—
showClear

Show clear link

boolean—
showCount

Show N of M header

boolean—
showCountBadge

Trigger count badge

boolean—
trigger

Custom trigger node

ReactNode—
triggerVariant

Default trigger styling

'default' | 'outline' | 'ghost' | 'subtle'—
groupOrder

Explicit group ordering

string[]—
labels

Override the built-in UI strings — selected-count summary, Select all, Clear, Loading, trigger aria template (i18n). Merged over DEFAULT_CHECKLIST_MENU_LABELS; {token} templates for counts.

Partial<ChecklistMenuLabels>—

Related

Platform docsAll componentsSource files