Slint Kit Documentation

Buttons and actions

Button for Slint

KitButton · Slint Kit 0.3.0

Slint button with a text label, busy state and activation callback.

Slint button with a text label, busy state and activation callback.
Native app built from the example below.

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.

Click the button: its Rust callback increments the displayed counter.

ui/app.slint

export { KitFormValidation, HtmlInputKind, NumberInputFormat, KitInputConstraints, KitValidationResult, KitValidityState } from "@kit/kit.slint";
import { KitButton, KitThemes } from "@kit/kit.slint";

export component App inherits Window {
    title: "Slint button";
    preferred-width: 420px;
    preferred-height: 220px;
    max-width: 100000px;
    max-height: 100000px;
    background: KitThemes.light.canvas;
    in property <int> count;
    callback increment();
    VerticalLayout {
        padding: 24px;
        spacing: 16px;
        alignment: start;
        button := KitButton { text: "Count in Rust"; activated => { root.increment(); } }
        count-label := Text { text: "Rust callback count: " + root.count; color: KitThemes.light.text-primary; }
    }
}

src/main.rs

use slint::ComponentHandle;
use std::cell::Cell;
slint::include_modules!();

fn main() -> Result<(), slint::PlatformError> {
    let app = App::new()?;
    slint_kit::init_form_validation!(self, app);
    let count = Cell::new(0_i32);
    let weak = app.as_weak();
    app.on_increment(move || {
        if let Some(app) = weak.upgrade() {
            let next = count.get().checked_add(1).expect("counter capacity");
            count.set(next);
            app.set_count(next);
        }
    });
    app.run()
}

Cargo.toml and build.rs

Cargo.toml

[package]
name = "slint-kit-button-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

Set text, then handle activated to run your action. Set busy while the action is pending; use control-width: ControlWidth.fill to fill a layout cell.

Enter activates on press; Space activates on release. busy and disabled block activation. The label keeps its measured width while the busy indicator is shown, and supplies the accessible name unless accessible-name is set.

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
Slint button with a text label, busy state and activation callback.
Native screenshot of the same example, rendered with Skia.
// SPDX-License-Identifier: GPL-3.0-or-later
import { KitButton, KitTheme, KitThemes } from "@kit/kit.slint";

export component Example inherits Window {
    title: "KitButton 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: "Button"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitButton { theme: root.theme; text: "Save changes"; activated => { root.status = "Action 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
text 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

See also