Form structure

KitFieldDescription

Secondary help text for a field.

Place it below the editor inside KitField and set its inherited text property. Use it for persistent instructions or the expected format.

It uses caption typography and wraps. Showing it does not change the field’s validation state.

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

export component Example inherits Window {
    title: "KitFieldDescription example";
    preferred-width: 420px;
    preferred-height: 220px;
    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: "Field Description"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitTextField { theme: root.theme; label: "Username"; text: "alex"; } KitFieldDescription { theme: root.theme; text: "Use 3–24 letters, numbers or underscores."; }
        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 Text. The declarations below come from the component source. Parent properties remain available; see the controller guide for state management.

Properties