TextField

import { TextField, Vertical } from "@material";
export component Example inherits Window {
    width: 200px;
    height: 100px;

    Vertical {
        TextField {
            label: "Name";
        }
    }
}

slint

A widget used to enter a single line of text with additional features like icons and supporting text.

Properties

enabled

booldefault: true

When false, the text field is disabled and cannot be interacted with.

has-error

booldefault: false

Indicates whether the text field should display an error state.

has-focus

bool(out)

Set to true when the text field currently has the focus.

label

stringdefault: ""

The label text displayed above the text input.

leading-icon

imagedefault: the empty image

An icon displayed at the beginning of the text input.

supporting-text

stringdefault: ""

Additional text displayed below the text input, often used for hints or error messages.

text

string(in-out)default: ""

The text being edited.

trailing-icon

imagedefault: the empty image

An icon displayed at the end of the text input.

input-type

enum InputTypedefault: text

Use this to configure TextInput for editing special input, such as password fields.

Functions

set-selection-offsets(anchor: int, focus: int)

Selects the text between two UTF-8 offsets: anchor is the end of the selection that stays put and focus the end the cursor moves to, so focus may precede anchor to select backwards. Pass the same value for both to place the text cursor at that offset without selecting anything.

select-all()

Selects all text in the text field.

clear-selection()

Clears the current text selection.

cut()

Copies the selected text to the clipboard and removes it from the text field.

copy()

Copies the selected text to the clipboard.

paste()

Pastes the text content of the clipboard at the cursor position.

Callbacks

accepted(string)

Invoked when the enter key is pressed.

edited(string)

Emitted when the text has changed because the user modified it.

key-pressed(KeyEvent) -> EventResult

Invoked when a key is pressed, the argument is a KeyEvent struct. Use this callback to handle keys before TextField does. Return accept to indicate that you’ve handled the event, or return reject to let TextField handle it.

key-released(KeyEvent) -> EventResult

Invoked when a key is released, the argument is a KeyEvent struct. Use this callback to handle keys before TextField does. Return accept to indicate that you’ve handled the event, or return reject to let TextField handle it.

leading-icon-clicked()

Invoked when the leading icon is clicked.

trailing-icon-clicked()

Invoked when the trailing icon is clicked.