Skip to content
Mizen UI
Docs

IntroductionInstallationCLIStylingFoundationsThemingCompositionIntegrationsAccessibilityFor agents

useCopyToClipboard

AccordionAspect RatioCardCollapsibleFrameGridGroupInlineScroll AreaSectionSeparatorSpacerStack

BlockquoteCitationCodeHeadingKbdLabelLinkTextVisually Hidden

ButtonButton GroupToggleToggle groupToolbar

CalendarCheckboxCheckbox groupComboboxDate pickerDate range pickerDate-Time InputFieldFieldsetFile UploadFormInputInput groupNumber fieldOTP FieldRadio groupSelectSliderSwitchTextareaTime Input

BreadcrumbMenubarNavigation MenuPaginationSegmented ControlStepperTabs

Alert dialogCommandContext MenuDialogDrawerMenuPopoverPreview CardSheetTooltip

AlertBadgeEmptyError StateMeterProgressSkeletonSpinnerStatus dotToast

Activity FeedAvatarAvatar GroupData TableListMetricOverflow ListProperty ListTableTokenTree

Area ChartBar ListCalendar HeatmapCategory ComparisonChart FrameChart LegendChart TooltipDistributionFunnelHeatmapMetric TrendPart-to-WholeProgress RingsRadar ChartRadial BarsSankey ChartScatter ChartScore GaugeTime Series

Diagram

AttachmentCarouselCode BlockLightboxMarkdownThumbnailTimestamp

Agent ThinkingApproval CardComposerConversationInline CitationMessageMessage ScrollerQuestion CardSourcesStreaming TextSuggestionTask ListTerminalTool Call

On this page

  • Preview
  • Usage
  • Examples
  • Delivery preferences
  • Digest schedule
  • Recommendations
  • Usage boundaries
  • API reference

Forms

Checkbox group

Coordinates related checkbox values and parent selection.

idle

Usage

import { CheckboxGroup } from "@mizen-labs/ui";

Examples

Delivery preferences

Select individual channels or enable them together.

Digest schedule

Recommendations

GuidancePractice
Do

Give the group a shared label and each option a distinct value. Use parent selection for an explicit select-all task.

Do

Set allValues when using the parent checkbox so it can derive mixed state.

Usage boundaries

GuidanceBoundary
Scope

The group coordinates selected values. The application decides how those values affect records or permissions.

API reference

Public props from @mizen-labs/ui. Use exported prop types for the complete TypeScript contract.

PropTypeDefaultDescription
valuestring[]—Controls the selected checkbox values.
defaultValuestring[]—Sets initial selected values.
onValueChange(value: string[], eventDetails) => void—Receives selected-value changes.
disabledbooleanfalsePrevents interaction across the group.
PreviousCheckboxNextCombobox

Notification channels