Button

Check out the standard help for an overview of the button component.

API Examples

// Internally the component is known as "button"
var buttonComponent1 = findComponent("My Page", "button", "MyButton"); // To retrieve a button component called "MyButton" on a page called "My Page"
var buttonComponent2 = findComponentInForeground("My Foreground", "button", "MyButton"); // To retrieve a button component in the foreground.
var buttonComponent3 = createComponent(parentComponent, "button", 0, 0, 100, 100); // to create a button component inside a custom component.
 
// Retrieving a property
var textOnButton = getProperty(buttonComponent1, "text");
console.log(textOnButton);
 
// Setting a property
setProperty(buttonComponent1, "text", "Click Me!"); 
setProperty(buttonComponent1, "icon_x_pos", 0.1); 

// Binding an event
bindEvent(buttonComponent3, "on_press", "action");
function action(){
    console.log("hello world");
}

Properties

See the shared property list for all properties available for this component.

See the shared event list for all events available for this component.