UITextInputElementCreate
The parameters for creating a text input element.
See UITextInputElement for more details.
Remarks
id
is optional but recommended if you want to be able to perform updates.
Properties
type
type:
"TextInput"
value
value:
string
The value of the input. Use ""
for empty values.
placeholder?
optional
placeholder:string
The placeholder text to display in the input.
onChange()?
optional
onChange: (args
: {value
:string
;id
:string
; }) =>void
The function to call when the value of the input changes.
Parameters
args
{ value
: string
; id
: string
; }
The arguments passed to the function.
args.value
string
The value of the input.
args.id
string
The id of the input element.
Returns
void
onBlur()?
optional
onBlur: (args
: {value
:string
;id
:string
; }) =>void
The function to call when the input is blurred.
Parameters
args
{ value
: string
; id
: string
; }
The arguments passed to the function.
args.value
string
The value of the input.
args.id
string
The id of the input element.
Returns
void
onFocus()?
optional
onFocus: (args
: {value
:string
;id
:string
; }) =>void
The function to call when the input is focused.
Parameters
args
{ value
: string
; id
: string
; }
The arguments passed to the function.
args.value
string
The value of the input.
args.id
string
The id of the input element.
Returns
void
onCreate()?
optional
onCreate: (args
: {id
:string
; }) =>void
A function to call when the element is created.
Parameters
args
{ id
: string
; }
The arguments passed to the function.
args.id
string
The id of the element.
Returns
void
onDestroy()?
optional
onDestroy: (args
: {id
:string
; }) =>void
A function to call when the element is destroyed.
Parameters
args
{ id
: string
; }
The arguments passed to the function.
args.id
string
The id of the element.
Returns
void
id?
optional
id:string
The ID of the element.
Remarks
If not provided, the element will be assigned a random ID, but it is recommended to provide it to perform further updates on the element.
If provided, it must be unique within the UI.
Default Value
undefined
label?
optional
label:string
Label text to display above the element and used for screen readers.
Last updated
Was this helpful?