Skip to content

Textinput

[TextInput]{#TextInput data-4search="ui/b/textinput.tsx:TextInput;section"}

The TextInput component is a field-editor for text input.

Props:

value : Contains the text string being edited. Used only when no prop is supplied; when a prop is given the display follows its backend value. placeholder : Placeholder string shown when the field is empty. readonly : Make this component non editable for the user. disabled : When true the field is treated as readonly (mirrored onto the native <input readonly> attribute and also blocks the file-picker click handler). prop : An extended property (extend_property); edits are forwarded via prop.apply_() and the display is refreshed on backend notifications. label : Forwarded onto the <input> as aria-label. title : Forwarded onto the root element as the native tooltip attribute. class : Extra CSS class(es) appended to the root .b-textinput element.

Events:

valuechange : Event emitted whenever the user edits the text and the value actually changes. The new value is provided as event.target.value (set on the root element before dispatch). When a prop is supplied the value is also pushed to the backend via prop.apply_().