UITextInputElementCreate
The parameters for creating a text input element.
SeeUITextInputElement 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?
optionalplaceholder:string
The placeholder text to display in the input.
onChange()?
optionalonChange: (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()?
optionalonBlur: (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()?
optionalonFocus: (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()?
optionalonCreate: (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()?
optionalonDestroy: (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?
optionalid: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?
optionallabel:string
Label text to display above the element and used for screen readers.
Last updated
Was this helpful?