(Object, Component<Button>). Used as either a text or image button, with generic colour styling for visual differentiation.
Note. ‘Returns:’ refers to what the Component value returns when exported to its .variable binding.
<component_key>: (Object, Component<BasicColour>)
- Inherits from Component.
- name: (String, Localisation) - Optional.
- placeholder: (Boolean) - Optional. Either true or false. If defined, the button is seen as a toggle (see also
.toggle). Undefined by default.
- colour: (String) - Same colours as in localisation.
- ‘black’
- ‘blue’
- ‘green’
- ‘light_grey’
- ‘orange’
- ‘red’
- ‘white’
- ‘yellow’
- ‘reset’ - Resets colour.
- icon: (String) - Optional. The file path to the image icon to use. By default, this is inline and to the left of
.name.
- icon_only: (Boolean) - Optional. Whether to hide the background and display only the icon (i.e. as an icon gallery). False by default.
- off_colour: (String) - Either ‘red’/'grey'. Determines the colour when the toggle is off.
- off_name: (String)
- on_name: (String)
- toggle: (Boolean) - Optional. Whether the button is of type toggle. False by default.
- Returns: (Boolean) - Returns undefined by default if
.toggle is false.