A text input.
Props
chevronIcon
Icon to use as a chevron.
[namespace: stringor
symbol, name: string]or
stringor
undefined
disabled
If the field is disabled.
booleanor
undefined
documentation
Inline documentation text.
stringor
undefined
documentationLink
Inline documentation link.
stringor
undefined
documentationLinkText
Inline documentation link text.
stringor
undefined
inputProps
Pass props directly to the input.
undefinedor
{ [x: string]: any; }invalid
If the field is currently invalid.
booleanor
undefined
label
The label of the field.
string
messages
The messages to display under the field.
ValidationMessagesor
undefined
name
The name of the field.
string
optionFilter
Pass a custom search filter function
((filter: string, option: TypeaheadOption) => boolean)or
undefined
options
A list of options to choose from.
TypeaheadOption[]
placeholder
The placeholder for the input.
stringor
undefined
readonly
If the field is editable.
booleanor
undefined
renderOption
Overwrite the default option renderer.
((h: typeof h, option: any, chosen: boolean) => stringor
VNodeor
VNode[]or
null)or
undefined
renderValue
Overwrite the default value renderer.
((h: typeof h, value: any, rawValue: string) => stringor
VNodeor
VNode[]or
null)or
undefined
templated
If the field is templated.
no-editor
booleanor
undefined
value
The current value of the field.
nullor
string
ValidationMessages
TypeaheadOption
An option to be selected.
The display name of the option.
The string to be used as a value.
Events
enter
any
Emitted on keyup of enter, if no modifier keys are held.
fieldchange
FieldChange<string, string>
Emitted when the value of the field is changed.
requestEdit
string
Emitted when the user requests to edit.