The TextField widget allows users to collect inputs from the keyboard into an app. This widget is used in building forms, sending messages, and creating search experiences.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Custom ValidationRegular expression used for custom validation.
DisabledThe widget cannot be used.
Display LimitDisplays the remaining Character Allowed for User to type.
Error MessageMessage shown when the validation fails.
HiddenHides the widget from the user.
Hide InputHide the input so that the characters entered are not visible to the user. This is typically used when entering senstive information such as passwords.
Max LengthThe maximum number of characters to accept.
PlaceholderValue to display until the user has entered something. This can provide the user with a clue as to what type of information is requested in the field.
Prompt MessageMessage that prompts the user for some information.
Required MessageMessage that notifies the user that input is required.
Spell Check
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.
ValidationValidation is used to ensure correct input.

Style

Name Desciption
Background-colorChange background color of the widget.
Border colorAdd the color for the border.
Border radiusAdd curves to the borders of the widget.
Border styleThe style of the border whether it is solid, dotted or dashed.
Border widthDefine the border width in pixels for the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Padding (right left)Generate space around the widget’s left and right area.
Padding (top bottom)Generate space around the widget’s top and bottom area.
Text-alignmentSet left, centered or right. Applies both to icon and text.
Transparent backgroundEnable to make the background color of the widget transparent.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Change Event triggered after the element has finished changing.
event The current value of the TextField.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.
KeyDown Triggered when the user is pressing a key on the element.
event Object with information about the code (event.code), key (event.key) and key code (event.keyCode) that triggered the event.
KeyPress Event triggered when a keypress event occurs on the element.
event Object with information about the code (event.code), key (event.key) and key code (event.keyCode) that triggered the event.
KeyUp Event triggered to an element when the user releases a key on the keyboard.
event Object with information about the code (event.code), key (event.key) and key code (event.keyCode) that triggered the event.

Function

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.