Slint Kit Documentation

Choices and values

KitCheckbox

Controlled checkbox with a genuine mixed state.

Controlled checkbox with a genuine mixed state.
Native screenshot of the same example, rendered with Skia.

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 ↗

Complete example

This complete Slint file is a visual composition used to produce the screenshot above. Internal strings without a label property retain the kit’s default language; system dialogs follow the host platform. Projected state and callbacks requesting a decision need host wiring; the standalone fixture does not supply that controller. Set up the Rust project, then see the typed controller application for working editing, validation and selection.

// 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. The declarations below come from the component source. Parent properties remain available; see the controller guide for state management.

Properties

Name Type Direction
state CheckState in
access FieldAccess in
label string in

Types and variants

Names below use Slint syntax. Shared Rust domain types live in slint_kit; presentation enums come from the Rust types generated by Slint.

Type Declaration
enum CheckState unchecked, checked, mixed
enum FieldAccess editable, read-only, disabled

Callbacks

See also