Checkbox for Slint

KitCheckbox · Slint Kit 0.3.0

Controlled checkbox with a genuine mixed state.

Try the component

Download the complete project, extract it and run cargo run --locked in its folder. Rust 1.92+; Slint Kit 0.3.0 from crates.io. You can also copy the four files below.

Toggle the checkbox; the accepted CheckState is held by Rust.

ui/app.slint

export { KitFormValidation, HtmlInputKind, NumberInputFormat, KitInputConstraints, KitValidationResult, KitValidityState } from "@kit/kit.slint";
// SPDX-License-Identifier: GPL-3.0-or-later
import { KitCheckbox, CheckState, KitTheme, KitThemes } from "@kit/kit.slint";
export component App inherits Window {
    title: "KitCheckbox example";
    preferred-width: 520px;
    preferred-height: 280px;
    max-width: 100000px;
    max-height: 100000px;
    background: root.theme.canvas;
    in-out property <KitTheme> theme: KitThemes.light;
    in property <CheckState> choice: CheckState.unchecked;
    callback change(CheckState);
    VerticalLayout {
        padding: 24px;
        spacing: 16px;
        alignment: start;
        control := KitCheckbox { theme: root.theme; label: "Send product updates"; state: root.choice; toggled(value) => { root.change(value); } }
        result := Text { text: root.choice == CheckState.checked ? "Subscribed" : "Not subscribed"; color: root.theme.text-primary; }
    }

}

src/main.rs

// SPDX-License-Identifier: GPL-3.0-or-later
use slint::ComponentHandle;

mod ui { slint::include_modules!(); }
fn main() -> Result<(), slint::PlatformError> {
    let app = ui::App::new()?;
    slint_kit::init_form_validation!(ui, app);
    let weak = app.as_weak();
    app.on_change(move |choice| { if let Some(app) = weak.upgrade() { app.set_choice(choice); } });
    app.run()
}

Cargo.toml and build.rs

Cargo.toml

[package]
name = "slint-kit-checkbox-example"
version = "0.1.0"
edition = "2024"
rust-version = "1.92"
license = "GPL-3.0-or-later"
publish = false

[dependencies]
slint-kit = "=0.3.0"
slint = { version = "=1.18.1", default-features = false, features = ["std", "compat-1-18", "backend-winit", "renderer-skia", "accessibility"] }

[build-dependencies]
slint-kit-build = "=0.3.0"

[workspace]

build.rs

fn main() { slint_kit_build::compile("ui/app.slint").expect("compile component example"); }

Files: Cargo.toml · build.rs · ui/app.slint · src/main.rs

Project CheckState.unchecked, .checked or .mixed and accept toggled(CheckState) requests in the controller. Supply label and FieldAccess.

Activation requests checked unless currently .checked, which requests unchecked. Mixed remains distinct, and read-only access allows focus without modification.

View source ↗

Choose between built-in options and custom composition

Shared options

label — built-in property; custom composition example

Visual composition

The file below produces the screenshot. For controller-driven components, it shows the displayed state without supplying the Rust wiring. Create a project.

Show the screenshot source

// SPDX-License-Identifier: GPL-3.0-or-later
import { CheckState, KitCheckbox, KitTheme, KitThemes } from "@kit/kit.slint";

export component Example inherits Window {
    title: "KitCheckbox example";
    preferred-width: 360px;
    preferred-height: 160px;
    max-width: 100000px;
    max-height: 100000px;
    background: root.theme.canvas;
    in-out property <KitTheme> theme: KitThemes.light;
    in-out property <string> status;
    VerticalLayout {
        padding: 24px; spacing: 16px; alignment: start;
        Text { text: "Checkbox"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitCheckbox { theme: root.theme; label: "Send me product updates"; state: CheckState.checked; toggled(state) => { root.status = "Checkbox change requested"; } }
        if root.status != "": Text { text: root.status; color: root.theme.text-secondary; font-size: 12px * root.theme.text-scale; wrap: word-wrap; }
    }
}

Download this example

Public API

Inherits KitPressable.

Properties

Name	Type	Direction
`required`	`bool`	`in`
`required-message`	`string`	`in`
`custom-validity`	`string`	`in-out`
`validity`	`KitValidityState`	`out`
`will-validate`	`bool`	`out`
`validation-message`	`string`	`out`
`state`	`CheckState`	`in`
`access`	`FieldAccess`	`in`
`label`	`string`	`in`

Available inherited properties

Name	Type	Defined on
`theme`	`KitTheme`	`KitPressable`
`intent`	`ButtonIntent`	`KitPressable`
`control-size`	`ControlSize`	`KitPressable`
`control-width`	`ControlWidth`	`KitPressable`
`recipe`	`ButtonRecipe`	`KitPressable`
`accessible-name`	`string`	`KitPressable`
`disabled`	`bool`	`KitPressable`
`busy`	`bool`	`KitPressable`
`tab-stop`	`bool`	`KitPressable`
`hovered`	`bool`	`KitPressable`
`pressed`	`bool`	`KitPressable`
`has-focus`	`bool`	`KitPressable`
`focus-visible`	`bool`	`KitPressable`

Types and variants

Type	Declaration
`enum CheckState`	`unchecked, checked, mixed`
`enum FieldAccess`	`editable, read-only, disabled`
`struct KitValidityState`	`valid: bool, value-missing: bool, type-mismatch: bool, pattern-mismatch: bool, too-long: bool, too-short: bool, range-underflow: bool, range-overflow: bool, step-mismatch: bool, bad-input: bool, custom-error: bool,`

Callbacks

invalid()
toggled(CheckState)

Functions

check-validity() → bool
report-validity() → bool
set-custom-validity(message: string)
reset-validation()