Logo FS-Skia-UI

TextInput Module

MVU text-field component covering caret, selection, IME composition, clipboard, and validation.

Functions and values

Function or value Description

diagnostics model

Full Usage: diagnostics model

Parameters:
Returns: ControlDiagnostic list

Returns the `ControlDiagnostic` list implied by the current `model` state.

model : TextInputModel
Returns: ControlDiagnostic list

init controlId mode value

Full Usage: init controlId mode value

Parameters:
Returns: TextInputModel * TextInputEffect list

Seeds a `TextInputModel` for `controlId` in the given `mode` with an initial `value`, plus any startup effects.

controlId : ControlId
mode : TextInputMode
value : string
Returns: TextInputModel * TextInputEffect list

interpretEffect effect

Full Usage: interpretEffect effect

Parameters:
Returns: TextInputMsg option

Maps a host-fulfilled `effect` back into the `TextInputMsg` that feeds it into `update`, if any.

effect : TextInputEffect
Returns: TextInputMsg option

update msg model

Full Usage: update msg model

Parameters:
Returns: TextInputModel * TextInputEffect list

Pure transition applying `msg` to `model`, returning the next model and the `TextInputEffect` list it raises.

msg : TextInputMsg
model : TextInputModel
Returns: TextInputModel * TextInputEffect list

Type something to start searching.