Skip to content
wdj

Checkbox

Implemented Input

Single checkbox and indeterminate state.

Kumo reference: kumo-ui.com/components/checkbox/

Presentation commands show demo feedback. Read the interaction guide to connect real actions.

Basic

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_basic" label="Accept terms and conditions" only %}

Checked

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_checked" label="Notifications" checked=True only %}

Indeterminate

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_indeterminate" label="Select all" indeterminate=True only %}

Disabled

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_disabled" label="Unavailable" disabled=True only %}

Disabled checked

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_disabled_checked" label="Managed setting" disabled=True checked=True only %}

Description

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_description" label="Analytics" description="Collect anonymous usage statistics." only %}

Required

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_required" label="Accept terms" required=True only %}

Error

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_error" label="Accept terms" error="You must accept the terms." only %}

Group

Notifications
Show template
{% load wdj %}
<fieldset class="grid gap-3"><legend class="mb-2 text-base font-medium">Notifications</legend>{% include "wdj/components/checkbox.html" with name="check_email" label="Email" checked=True only %}{% include "wdj/components/checkbox.html" with name="check_sms" label="SMS" only %}</fieldset>

Surface

Show template
{% load wdj %}
{% wdj_component "wdj/components/card.html"  %}
{% include "wdj/components/checkbox.html" with name="check_card" label="Enable automatic updates" description="Install updates when available." only %}
{% endwdj_component %}

Label first

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_label_first" label="Remember me" control_first=False only %}

Error variant

Show template
{% load wdj %}
{% include "wdj/components/checkbox.html" with name="check_variant_error" label="Invalid option" variant="error" only %}

Hidden legend

Notification preferences
Show template
{% load wdj %}
<fieldset class="grid gap-3"><legend class="wdj-sr-only">Notification preferences</legend>{% include "wdj/components/checkbox.html" with name="check_hidden_email" label="Email" only %}{% include "wdj/components/checkbox.html" with name="check_hidden_sms" label="SMS" only %}</fieldset>

Group with error

Notifications
Show template
{% load wdj %}
{% include "wdj/components/choice_group.html" with legend="Notifications" name="audit-checkbox-group-with-error" items=audit_choices error="Choose a notification method." only %}

Card choices

Notifications
Show template
{% load wdj %}
{% include "wdj/components/choice_group.html" with legend="Notifications" name="audit-checkbox-card-choices" items=audit_choices appearance="card" only %}

Horizontal card choices

Notifications
Show template
{% load wdj %}
{% include "wdj/components/choice_group.html" with legend="Notifications" name="audit-checkbox-horizontal-card-choices" items=audit_choices appearance="card" orientation="horizontal" only %}

Styled legend

Notifications
Show template
{% load wdj %}
{% include "wdj/components/choice_group.html" with legend="Notifications" name="audit-checkbox-styled-legend" items=audit_choices class="rounded-lg bg-kumo-recessed p-4" only %}

Custom group legend

Notification preferences
Show template
{% load wdj %}
{% include "wdj/components/choice_group.html" with items=audit_choices name="audit-custom-checkbox-legend" legend="Notification preferences" legend_class="text-lg" only %}

API Reference

Prop Type Default Description
string unset Name; pass the documented value shown in the examples.
string unset Value; pass the documented value shown in the examples.
string unset Visible accessible label. Supply an explicit aria-label via attrs when the control is bare.
string unset Description; pass the documented value shown in the examples.
bool False Checked; pass the documented value shown in the examples.
bool False Indeterminate; pass the documented value shown in the examples.
bool False Required; pass the documented value shown in the examples.
bool False Disabled; pass the documented value shown in the examples.
string unset Validation message; implies error styling and accessible error association.
string component-specific Variant; pass the documented value shown in the examples.
string unset Checkbox: card or default. Radio: default/card/segmented. Badge: filled/dot.
string unset Control first; pass the documented value shown in the examples.
string unset Stable unique DOM ID; important for HTMX targets and focus restoration.
dict {} Dictionary of escaped native, HTMX or Alpine attributes. Literal Tailwind classes only.
string "" Class; pass the documented value shown in the examples.

Accessibility notes

Every interactive component keeps real semantics and keyboard support: native controls where possible, ARIA only where necessary, and a visible focus ring. See the Accessibility page for the shared contract.

Read the accessibility contract

Components

Components overview
AutocompleteFree-form input with local or HTMX-filtered suggestions.
BadgeSolid, tinted, outline and dot status labels.
BannerInline message bar with variants and optional action.
BreadcrumbsTrail navigation in two sizes.
ButtonVariants, sizes, shapes, icons and loading state.
ButtonGroupJoins a small set of tightly-coupled buttons into a single control (split buttons).
CheckboxSingle checkbox and indeterminate state.
ClipboardTextRead-only text field with a one-click copy-to-clipboard button.
Code / CodeHighlightedEscaped Pygments grammar highlighting, multiline tokens, line numbers, highlighted lines and localized copying.
CollapsibleComposable disclosure component for showing and hiding content.
Combobox / AutocompleteKumo-styled input/button triggers, search inside the popup, grouped local choices and debounced HTMX search.
CommandPaletteAccessible spotlight search overlay with Cmd+K keyboard shortcut.
DatePickerKumo-styled date and datetime popups; inline single, multiple and range calendars with bounds/presets.
DateRangePickerStyled popup or inline range calendar with bounds, presets and separately named form values.
DialogNative <dialog> modal with focus management.
DrawerEdge-anchored modal panel. LayerDialog has its own layered component.
DropdownMenuNative details menu with delegated keyboard navigation and dismissal.
EmptyEmpty-state placeholder with icon and action.
FieldLabel + description + error wrapper. Built into each control.
FlowDirected diagrams with branches, SVG connectors, custom anchors and responsive local scrolling.
GridResponsive CSS grid layout container with preset column configurations.
InlineCopyTextCompact borderless copy control for IDs and short values.
InputText field with label, description, leading/trailing icons.
InputAreaMulti-line textarea with auto-resize option.
InputGroupInput field with seamless prefix, suffix, and addon attachments.
LabelForm field label, optional marker and tooltip.
LayerCardCompound surface card with distinct primary and secondary layers.
LayerDialogLayered native modal with actions, forms, nested dialogs and pending states.
LinkInline, current and plain text links.
LoaderAnimated spinner in three sizes.
MenuBarCompact view selector using native radio semantics.
MeterProgress bar showing a measured value within a known range.
PaginationA page navigation component for navigating through paginated content.
PopoverAnchored popup with interactive content.
RadioRadio group, vertical and horizontal.
SelectKumo-styled Alpine dropdown with groups, rich options and multiple selection; native form values and fallback.
SensitiveInputPassword/secret input with reveal toggle and copy button.
SeparatorHorizontal / vertical rules with optional label.
SidebarRecursive navigation groups, account/zone views, search, loading, resize and full-screen mobile breadcrumbs.
SkeletonShimmer placeholder.
SliderInset single/range selection with vertical grips, value badges, endpoint labels and native keyboard/form behavior.
SurfaceBordered surface panel with header slot.
SwitchOn/off toggle in three sizes.
TableServer-driven table: sort, filter, select and paginate the full dataset.
Table of contentsPage section navigation tree with active link indicator.
TabsSegmented and underline tabs with a sliding indicator, responsive overflow and local Alpine or URL/HTMX state.
TagInputMulti-value badge input for tags and recipients.
TextHeading, body, secondary, success, error and mono text.
ToastyExpandable notification stack with variants, paused expiry and a live region.
ToolbarCompact grouped controls with shared borders, composed filters and keyboard arrow navigation.
TooltipHover and focus tooltip with grouped delays, Escape dismissal and viewport bounds.
↑ ↓ Navigate ↵ Select