Forms

Checkbox

Make a choice that can be checked, cleared and bound to application data.

Open ↗
Checkbox interaction recorded with the Blinc headless renderer
Hybrid · dark · native recording · 2×

Usage and properties

Make a choice that can be checked, cleared and bound to application data. Apply CSS after the component layer to restyle the documented parts.

Use the installation guide to add blinc_cn and its component stylesheet. Create the fixture bindings once, and return the demo from your UI builder. Values marked Bound accept Signal/Computed sources where the API supports them; structural options configure the component at construction.

PropertyTypeUpdate modelThis example
checkedSignal<bool>Boundvalues.confirmed
labelstringConstructionKeep me signed in
disabledbool or IntoReactive<bool>Boundvalues.disabled

Keyboard and interaction

Tab reaches the checkbox; Space or Enter toggles it. :focus-visible marks keyboard focus.

Customizing it

Add application CSS after the default component layer. These selectors are the restyling surface for this component:

  • .cn-checkbox

Theme and component variables: --cn-checkbox-checked-bg, --cn-checkbox-checked-border, --cn-checkbox-checked-color, --primary, --text-primary, --text-secondary, --surface, --border, --radius-default, --duration-fast, --ease-state.

Built-in themes

The Live theme control installs Blinc's own theme bundles, including their colours, focus rings, corner shapes and motion tokens.

pub fn theme_bundle_for(name: &str) -> blinc_theme::ThemeBundle {
    match name {
        "restrained" => blinc_theme::RestrainedTheme::bundle(),
        "expressive" => blinc_theme::ExpressiveTheme::bundle(),
        _ => blinc_theme::HybridTheme::bundle(),
    }
    .with_css(blinc_cn::cn_styles::CN_STYLES)
}

Download the default widget and component stylesheets. Sample assets and licenses are available in the asset guide.

Documentation

From the canonical component guide.

A checkbox reads and writes the Signal<bool> it is given:

let accepted = ctx.use_signal(false);

checkbox(accepted)
    .label("Accept terms and conditions")
    .on_change(|checked| println!("checked: {checked}"))
checkbox(accepted).size(CheckboxSize::Large)
checkbox(accepted).disabled(locked)   // a bool, Signal or Computed

The label takes a string, Signal or Computed too.

Styling

A checkbox is an element with a checked attribute while it is checked and disabled while it cannot be used. Its fill, border colour, hover, the disabled palette and the mark's fade-in are the .cn-checkbox rules of CN_STYLES, with a transition. Restyle it with rules of your own:

@layer components {
    .my-checkbox:checked {
        background: #16a34a !important;
        border-color: #16a34a !important;
    }
}
.my-checkbox:hover:not(:disabled):not(:checked) { border-color: #16a34a; }
checkbox(accepted).class("my-checkbox")

Platforms and version

The component API is available in Blinc 0.6.0. The Live example runs in a dedicated worker and requires a compatible GPU surface. Preview and Code remain available when Live cannot start. The canvas has a descriptive label; a full screen-reader DOM mirror is not provided. The gallery integration is based on revision e2e55c24e078.

Recordings and live demos use the default Hybrid theme with bundled Noto Sans. The recording uses a 560 × 320 logical viewport at twice that resolution. Live follows its container and actual display density. Source base revision · Exact build source · Artifact versions and checksums · Font license.