Skip to main content

Input

Ant Design

The Input component is a single-line text field for entering values such as a name, an email address or a search term.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Label
ExtraHelp text shown under the field. A validation message replaces it while the value is invalid.Text
TooltipText shown when the user hovers over an info icon after the label.Text
Layoutvertical puts the label above the field; horizontal puts it at the left.vertical, horizontal. Default: vertical
ValueText in the field when the app loads. Reset field returns to this value.Text
PlaceholderHint shown in the field while it is empty.Text. Default: Enter your input
TypeKind of text the field expects. email and url show an error for text that isn't a valid address; password hides the text and adds a button to show it.text, email, password, url, tel, search. Default: text
Allow clearShows a button in the field that clears the text.On or off. Default: Off
Max lengthMost characters the user can type. Leave it at 0 for no limit.Number. Default: 0
Show countShows the number of characters typed, and the limit when Max length is set.On or off. Default: Off
PrefixText or an icon shown inside the field before the text, such as SearchOutlined.Text
SuffixText or an icon shown inside the field after the text, such as MailOutlined.Text
Addon beforeText shown in a gray box attached to the start of the field, such as https://.Text
Addon afterText shown in a gray box attached to the end of the field, such as .com.Text
VariantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the text changes, by typing or an action.
On press enterTriggers when the user presses Enter in the field.
On focusTriggers when the field gets focus.
On blurTriggers when the field loses focus.
On clearTriggers when the user clears the field with its clear button.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set field valueChanges the text to the given Value and fires On change.components.input1.setFieldValue("")
Reset fieldReturns the text to the Value property's value.components.input1.resetFields()
FocusMoves keyboard focus to the field.components.input1.focus()
BlurRemoves keyboard focus from the field.components.input1.blur()
Set visibilityShows the component when true, hides it when false.components.input1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.input1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.input1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.input1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is invalid.{{components.input1.extra}}
tooltipText shown when the user hovers over an info icon after the label.{{components.input1.tooltip}}
layoutvertical puts the label above the field; horizontal puts it at the left.{{components.input1.layout}}
valueText in the field when the app loads. Reset field returns to this value.{{components.input1.value}}
placeholderHint shown in the field while it is empty.{{components.input1.placeholder}}
typeKind of text the field expects. email and url show an error for text that isn't a valid address; password hides the text and adds a button to show it.{{components.input1.type}}
allowClearShows a button in the field that clears the text.{{components.input1.allowClear}}
maxLengthMost characters the user can type. Leave it at 0 for no limit.{{components.input1.maxLength}}
showCountShows the number of characters typed, and the limit when Max length is set.{{components.input1.showCount}}
prefixText or an icon shown inside the field before the text, such as SearchOutlined.{{components.input1.prefix}}
suffixText or an icon shown inside the field after the text, such as MailOutlined.{{components.input1.suffix}}
addonBeforeText shown in a gray box attached to the start of the field, such as https://.{{components.input1.addonBefore}}
addonAfterText shown in a gray box attached to the end of the field, such as .com.{{components.input1.addonAfter}}
variantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.{{components.input1.variant}}
sizeHeight and text size of the field.{{components.input1.size}}
isVisibleWhether the component is visible.{{components.input1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.input1.isLoading}}
isDisabledWhether the component is disabled.{{components.input1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.