Slint Kit Documentation

Navigation

Pagination for Slint

KitPagination · Slint Kit 0.3.0

Previous and next controls for a paged collection.

Previous and next controls for a paged collection.
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.

Navigate four pages; Rust keeps the page within the available range.

ui/app.slint

export { KitFormValidation, HtmlInputKind, NumberInputFormat, KitInputConstraints, KitValidationResult, KitValidityState } from "@kit/kit.slint";
// SPDX-License-Identifier: GPL-3.0-or-later
import { KitPagination, NavigationStep, KitTheme, KitThemes } from "@kit/kit.slint";
export component App inherits Window {
    title: "KitPagination example";
    preferred-width: 520px;
    preferred-height: 200px;
    max-width: 100000px;
    max-height: 100000px;
    background: root.theme.canvas;
    in-out property <KitTheme> theme: KitThemes.light;
    in property <int> page;
    callback navigate(NavigationStep);
    VerticalLayout {
        padding: 24px;
        spacing: 16px;
        alignment: start;
        control := KitPagination { theme: root.theme; page-index: root.page; page-count: 4; navigate(step) => { root.navigate(step); } }
        result := Text { text: "Page " + (root.page + 1) + " of 4"; 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_navigate(move |step| { if let Some(app) = weak.upgrade() {
        let page = app.get_page();
        let next = match step {
            ui::NavigationStep::Next | ui::NavigationStep::PageNext => (page + 1).min(3),
            ui::NavigationStep::Previous | ui::NavigationStep::PagePrevious => (page - 1).max(0),
            ui::NavigationStep::First => 0,
            ui::NavigationStep::Last => 3,
        };
        app.set_page(next);
    } });
    app.run()
}

Cargo.toml and build.rs

Cargo.toml

[package]
name = "slint-kit-pagination-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 zero-based page-index and page-count from a validated controller. Handle navigate(NavigationStep.previous) and .next to load or display a page.

The visible counter starts at one and shows 0 / 0 for an empty collection. Buttons disable at the limits; the view does not fetch remote data itself.

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
Previous and next controls for a paged collection.
Native screenshot of the same example, rendered with Skia.
// SPDX-License-Identifier: GPL-3.0-or-later
import { KitPagination, KitTheme, KitThemes } from "@kit/kit.slint";

export component Example inherits Window {
    title: "KitPagination 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: "Pagination"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitPagination { theme: root.theme; page-index: 2; page-count: 12; }
        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 HorizontalLayout.

Properties

Name Type Direction
theme KitTheme in
control-size ControlSize in
page-index int in
page-count int in
previous-label string in
next-label string in

Types and variants

Type Declaration
enum ControlSize compact, medium, comfortable
enum NavigationStep next, previous, first, last, page-next, page-previous

Callbacks

See also