text-input
text-input allows a user to type information in a text field.Version Compatibility
text-input was introduced in version 4.72.0 of the JourneyApps Runtime.<var name="job_name" type="text"/>
<text-input label="Job name" bind="job_name" required="true" />
Note:
- If the
bind=""option for atext-inputrefers to anintegerornumberfield or variable, a numeric keyboard will be provided. - When
bind=""refers to a field or variable of typetext, it is also possible to use different keyboard types using Text Subtypes (configured on the field or variable)
Optional
Default:
unsetOverride what is displayed in the
text-input when the user is not editing its content.<text-input bind="weight" label="Total weight" display="{weight} pounds"/>
Optional
Type:
booleanDefault:
falseVersion compatibility
enable-number-scrolling was introduced in version 4.84.0 of the JourneyApps Runtime.Specify whether a
text-input that is bound to a number field/variable should increase and decrease the number value when a user scrolls over the input using a mouse.Note: Prior to runtime version 4.84.0, number values will always increase/decrease with mouse scrolling in the
text-input component.Version compatibility
label-case was introduced in version 4.80.0 of the JourneyApps Runtime.Version compatibility
text-direction was introduced in version 4.86.1 of the JourneyApps Runtime.Optional
Type:
left-to-right | right-to-leftDefault:
left-to-rightSpecify the direction of text entry into the component.
The following component methods are available when an
id is assigned to the component and component.textInput({id:'my-id'}) is called from JS/TS:Programmatically clear a value entered into the
text-input.Programmatically focus the
text-input to allow the user to enter a value.function focus(){
component.textInput({id: 'my-id'}).focus();
}
Programmatically scroll until the
text-input is visible in the view.Last modified 3mo ago