The MobileButton widget is a fundamental UI element used for interaction. Use buttons to navigate, submit forms, click events or any other trigger point for an interaction.


  • UI Type:

Extends: BaseWidget ColoredWidget

Properties

Name Desciption
Button SizeSet the size of the button in the UI.
Button TypeSet how much space the button will take up in the UI.
ColorSet the color of the button.
DisabledThe widget cannot be used.
HiddenHides the widget from the user.
IconSet an icon to be displayed on the button.
LabelText label shown on the widget.
OutlineSet whether to show a solid button or just an outline.
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.

Style

Name Desciption
Background-colorChange background color of the widget.
Button pressed state colorBackground color of the button when it’s activated or clicked.
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.
Font weightModify text style and select a range from bold to lighter font weight.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
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.

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.

setLabel ( Label: String )

Sets the label on the button.

Parameters
Name Type Description
Label String Text or HTML to set as the label on this button.

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.