Slint Kit Documentation

Text input

KitMaskedField

Text field for a draft governed by a domain mask.

Text field for a draft governed by a domain mask.
Native screenshot of the same example, rendered with Skia.

Pass edited to the core’s compiled mask and accept the value through the controller. Leave ordinary separators in editable text.

It disables prose suggestions without rewriting the draft during composition. Mask rules and errors belong to the controller.

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

export component Example inherits Window {
    title: "KitMaskedField 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: "Masked Field"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitMaskedField { theme: root.theme; label: "Reference"; text: "AB-2048"; 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 KitTextField. The declarations below come from the component source. Parent properties remain available; see the controller guide for state management.

See also