Slint Kit Documentation

Layout

KitScrollArea

Vertical scrolling area for a content column.

Vertical scrolling area for a content column.
Native screenshot of the same example, rendered with Skia.

Allocate a finite viewport from the parent and add children in reading order. Use reveal(top, bottom) to show a region and scroll-to-start() to return to the beginning.

The column follows the visible width and grows vertically; horizontal scrolling is disabled. This container does not virtualize its children.

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 { KitButton, KitScrollArea, KitTextArea, KitTextField, KitTheme, KitThemes, LayoutSpace } from "@kit/kit.slint";

export component Example inherits Window {
    title: "KitScrollArea example";
    preferred-width: 480px;
    preferred-height: 290px;
    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: "Scroll Area"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitScrollArea { height: 190px; inset: LayoutSpace.compact; gap: LayoutSpace.regular; KitTextField { theme: root.theme; label: "Project name"; text: "Field notes"; } KitTextField { theme: root.theme; label: "Email address"; text: "alex@example.com"; } KitTextField { theme: root.theme; label: "Website"; text: "https://example.com"; } KitTextField { theme: root.theme; label: "Phone"; text: "+1 514 555 0132"; } KitTextArea { theme: root.theme; label: "Notes"; text: "Keep observations and decisions together."; } KitButton { theme: root.theme; text: "Save project"; 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 ScrollView. The declarations below come from the component source. Parent properties remain available; see the controller guide for state management.

Properties

Name Type Direction
gap LayoutSpace in
inset LayoutSpace 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 LayoutSpace none, tight, compact, regular, roomy, section

Functions