Slint Kit Documentation

Selection

KitOption

Customizable option row that captures identity when pressing begins.

Customizable option row that captures identity when pressing begins.
Native screenshot of the same example, rendered with Skia.

Supply option-data: OptionRow, then active and selected from the controller. Add visual content and handle activate(token, generation).

The option keeps tab-stop: false so the composite can manage keyboard focus. Changing option-data cancels the press so a recycled row cannot activate another identity.

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 { KitOption, KitTheme, KitThemes } from "@kit/kit.slint";

export component Example inherits Window {
    title: "KitOption example";
    preferred-width: 420px;
    preferred-height: 180px;
    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: "Option"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitOption { theme: root.theme; option-data: { token: 11, generation: 1, label: "Project overview", description: "Open project details", disabled: false }; selected: true; active: true; activate(token, generation) => { root.status = "Activated stable token " + token; } Text { text: "Project overview"; color: root.theme.text-primary; vertical-alignment: center; font-size: 14px * root.theme.text-scale; } }
        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
option-data OptionRow in
active bool in
selected bool 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
struct OptionRow token: int, generation: int, label: string, description: string, disabled: bool

Callbacks

See also