Button widget
A control that can execute an action on tap or click.
Test in Kitchen Sink (opens in a new tab)
Properties
| Property | Type | Description |
|---|---|---|
| label | string | The button label |
| enabled | boolean | Enables or disables the interactivity and input functionality of the widget |
| submitForm | boolean | If the button is inside a Form and upon on tap, it will execute the form's onSubmit action if this property is TRUE |
| onTap | action | Call Ensemble's built-in functions or execute code |
| onTapHaptic | enum | The type of haptic to perform when button is pressed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate |
| endingIcon | object | Icon placed behind the label, according to device text alignment |
| startingIcon | object | Icon placed in front of the label, according to device text alignment |
| gap | integer | The gap between the starting icon and ending icon |
Styles
| Property | Type | Description |
|---|---|---|
| outline | boolean | Whether the button should have an outline border instead of filled background |
| color | integer or string | Set the color for the button label starting with '0xFF' for full opacity. transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange |
| labelStyle | object | An object that determines the size, color, and decoration of text |
Box Styles (Inherited)
This widget also inherits these styles
| Property | Type | Description |
|---|---|---|
| margin | integer/string | Margin with CSS-style notation (1 to 4 integers) e.g. margin: 5 20 5 |
| padding | integer/string | Padding with CSS-style notation (1 to 4 integers) e.g. padding: 5 20 5 |
| backgroundColor | Color | The background color of this widget. |
| backgroundImage | BackgroundImage | The background image of this widget. |
| backgroundGradient | Gradient | The background gradient of this widget. |
| border | Border | The border of this widget. |
| shadow | Shadow | The shadow of this widget |
| clipContent | boolean | Some widgets (such as Image) may bleed through the container when borderRadius is set. Use this to apply a clipping to ensure this does not happen. |
| width | integer | The width of this widget. |
| height | integer | The height of this widget. |
| borderRadius | string or integer | The border radius of the widget. This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. |
| borderColor | integer or string | Sets the border color, starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange. |
| borderWidth | integer | Thickness of the border. Minimum value should be 0. |
| shadowColor | integer or string | Sets the box shadow color starting with '0xFF' for full opacity. Possible values: transparent, black, blue, white, red, grey, teal, amber, pink, purple, yellow, green, brown, cyan, indigo, lime, orange. |
| shadowOffset | array | The values in the array define the horizontal and vertical offset of the shadow. Example: if the shadowOffset is set to [2, 4], the shadow will be offset by 2 pixels horizontally and 4 pixels vertically from its original position. |
| shadowRadius | string or integer | The border radius of the widget. This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. |
| shadowStyle | string | The blur style to apply on the shadow: normal, solid, outer, inner. |
Base Styles (Inherited)
This widget also inherits these styles
This widget also inherits these base styles:
| Property | Type | Description |
|---|---|---|
| visible | boolean | Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified. |
| visibilityTransitionDuration | number | Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible. |
| elevation | integer | The z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. (Minimum: 0, Maximum: 24) |
| elevationShadowColor | Color | The shadow color for the elevation. |
| elevationBorderRadius | integer / string | If the widget has a borderRadius, this should be changed to have the same value. Use with CSS-like notation (1 to 4 integers). |
| alignment | Alignment | Align this widget relative to its parent. |
| stackPositionTop | integer | The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children. |
| stackPositionBottom | integer | The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children. |
| stackPositionLeft | integer | The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children. |
| stackPositionRight | integer | The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children. |
| captureWebPointer | boolean | Applicable for Web only. When overlaying widgets on top of certain HTML container (e.g., Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget. |
startingIcon
| Property | Type | Description |
|---|---|---|
| name | string | The name of the icon |
| library | string | Which icon library to use. default fontAwesome |
| color | color | (/widgets/types#Color) |
| size | integer |
endingIcon
| Property | Type | Description |
|---|---|---|
| name | string | The name of the icon |
| library | string | Which icon library to use. default fontAwesome |
| color | color | (/widgets/types#Color) |
| size | integer |