KitTextField

Native text field with a label, validation and supporting messages.

Bind text to the draft and handle edited, commit-requested and cancelled in a typed controller. Set FieldAccess.editable, .read-only or .disabled to match actual access.

The same TextInput preserves selection, caret, undo and IME composition across visual changes. ValidationPresentation presents validation; the controller owns accepted values and supplies grapheme counts.

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

export component Example inherits Window {
    title: "KitTextField 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: "Text Field"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitTextField { theme: root.theme; label: "Project name"; text: "Field notes"; edited(value) => { root.status = "Draft: " + value; } }
        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 KitField. The declarations below come from the component source. Parent properties remain available; see the controller guide for state management.

Properties

Name	Type	Direction
`theme`	`KitTheme`	`in`
`control-size`	`ControlSize`	`in`
`access`	`FieldAccess`	`in`
`validation`	`ValidationPresentation`	`in`
`purpose`	`TextPurpose`	`in`
`secret-visibility`	`SecretVisibility`	`in-out`
`line-mode`	`TextLineMode`	`in`
`resize-policy`	`ResizePolicy`	`in`
`min-lines`	`int`	`in`
`max-lines`	`int`	`in`
`label`	`string`	`in`
`accessible-name`	`string`	`in`
`input-method-hints`	`InputMethodHints`	`in`
`description`	`string`	`in`
`error`	`string`	`in`
`placeholder`	`string`	`in`
`text-letter-spacing`	`length`	`in`
`text-alignment`	`TextHorizontalAlignment`	`in`
`prefix`	`string`	`in`
`suffix`	`string`	`in`
`text`	`string`	`in-out`
`show-character-count`	`bool`	`in`
`character-count`	`int`	`in`
`reveal-label`	`string`	`in`
`hide-label`	`string`	`in`
`clear-label`	`string`	`in`
`character-count-label`	`string`	`in`
`checking-label`	`string`	`in`
`has-focus`	`bool`	`out`

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 ControlSize`	`compact, medium, comfortable`
`enum FieldAccess`	`editable, read-only, disabled`
`enum ResizePolicy`	`fixed, auto-grow`
`enum SecretVisibility`	`hidden, revealed`
`enum TextLineMode`	`single-line, multiline`
`enum TextPurpose`	`plain, email, url, telephone, password, search`
`enum ValidationPresentation`	`pristine, checking, valid, invalid`

Callbacks

edited(string)
commit-requested(string)
cancelled()
focus-observed(bool)

Functions

take-focus()
select-all()
copy-selection()
cancel-edit()