BigCommerce Docs

Allows you to display color controls for your widget.

Widget Configuration Output

{
  "backgroundColor": "#444444"
}

Note

The resulting color picker supports RGBA.

You can select transparent as a color. The returned value is the string “transparent”.

User Interface Output

JSON Schema

Property	Type	Description	Example
`type`	string	The type of setting component to display.	”color”
`label`	string	The user friendly message to inform the user how this setting will be used.	”Background color”
`id`	string	The variable name where the setting value will be available in the widget template.	”backgroundColor”
`default`	string	The default value to use when rendering the widget for the first time.	”#444444”