Logo FS-Skia-UI

TextBox Module

Builders for the `TextBox` control — a single-line editable text field.

Functions and values

Function or value Description

create arg1

Full Usage: create arg1

Parameters:
    arg0 : Attr<'msg> list

Returns: Control<'msg>
Type parameters: 'msg

Build a `TextBox` from its attributes; pair with `TextBox.value` and `onChanged`. The typed `Props` front door (`FS.Skia.UI.Controls.Typed`) is the recommended authoring path.

arg0 : Attr<'msg> list
Returns: Control<'msg>

onChanged arg1

Full Usage: onChanged arg1

Parameters:
    arg0 : string -> 'msg

Returns: Attr<'msg>
Type parameters: 'msg

Emit a `'msg` carrying the edited `string` on each `TextBox` change (`Attr.onChanged`).

arg0 : string -> 'msg
Returns: Attr<'msg>

readOnly arg1

Full Usage: readOnly arg1

Parameters:
    arg0 : bool

Returns: Attr<'msg>
Type parameters: 'msg

Make a `TextBox` display-only (`Attr.readOnly`; `true` shows the value but blocks editing). Omitted ≡ editable.

arg0 : bool
Returns: Attr<'msg>

validation arg1

Full Usage: validation arg1

Parameters:
Returns: Attr<'msg>
Type parameters: 'msg

Attach a `ValidationState` to a `TextBox` so it renders the matching valid/invalid styling (`Attr.validation`).

arg0 : ValidationState
Returns: Attr<'msg>

value arg1

Full Usage: value arg1

Parameters:
    arg0 : string

Returns: Attr<'msg>
Type parameters: 'msg

Set the current text in a `TextBox` (`Attr.value`; a controlled `string` driven from model state and reconciled via `onChanged`).

arg0 : string
Returns: Attr<'msg>

Type something to start searching.