8.7 released—WinterCG Compliance Part 1
Learn more
Button
Represents a standard Button widget.

Summary

Constructors

constructor

Properties

android
ios
tapEvent
textWrap
169 properties inherited from TextBase
Click to expand

Methods

on
111 methods inherited from TextBase
Click to expand

Constructors

constructor

new Button(): Button

Properties

android

android: any
Gets the native [android widget](http://developer.android.com/reference/android/widget/Button.html) that represents the user interface for this component. Valid only when running on Android OS.

ios

ios: any
Gets the native [UIButton](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIButton_Class/) that represents the user interface for this component. Valid only when running on iOS.

textWrap

textWrap: boolean
Gets or sets whether the Button wraps text or not.

tapEvent

Static
tapEvent: string
String value used when hooking to tap event.

Methods

on

on(eventNames: string, callback: (data: EventData) => void, thisArg?: any): void
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
Parameter Default Description
eventNames
string

String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").

callback
(data: EventData) => void

Callback function which will be executed when event is raised.

thisArg
any

An optional parameter which will be used as `this` context for callback execution.

Returns void
on(event: "tap", callback: (args: EventData) => void, thisArg?: any): void
Raised when a tap event occurs.
Parameter Default Description
event
"tap"

callback
(args: EventData) => void

thisArg
any

Returns void
Previous
Builder