(Object, Component<Colour>). Adds an advanced colour wheel/square to your UI with kitchen sink optioning. Note that for most cases, this will likely be too much unless you intend on making it a central part of your UI. See Object, Component<BasicColour> (.type = 'basic_colour'
) for a better alternative here.
Note. ‘Returns:’ refers to what the Component value returns when exported to its .variable
binding.
<component_key>: (Object, Component<Colour>)
- Inherits from Component.
- name: (String, Localisation) - Optional.
- placeholder: (Array<number, number, number>/Array<number, number, number, number>/Function/String) - Note that if it is a String, a valid hex code must be provided, preferably prefixed with #.
- colour_swatch: (Function/Object<Array<number, number, number, number>>) - Optional. A swatch of colours to have at the bottom of your Component. Note that it may also be a function that returns said swatches. When left undefined, colour swatches do not display.
- disable_animation: (Booelan) - Whether to disable CSS animations for the colour picker cursor.
- disable_brightness_slider: (Boolean) - Whether to disable the brightness slider.
- disable_opacity: (Boolean) - Whether to disable opacity optioning (alpha channel).
- disable_opacity_slider: (Boolean) - Whether to disable the opacity slider.
- enable_eyedropper: (Boolean) - Whether to have an eyedropper control for the Colour wheel.
- layout: (Object/String) - Optioinal. If a String, it should either be of type ‘circle’/'square'. ‘circle’ by default.
- type: (String) - Either ‘circle’/'square'. When an object is specified, it is ‘square’ by default.
- height: (Number/String)
- width: (Number/String)
- Returns: (Array<number, number, number>)