Opens the editor's color picker for the selected component, letting a Wix user choose a solid color or gradient.
params accepts one of the following shapes:
For more information on this choice, see Picker arguments.
Connects the picker to a manifest style field, so the selected color saves to it automatically.
| Name | Type | Description |
|---|---|---|
styleItemKey | string | Key of a cssProperties or cssCustomProperties field in the manifest. The editor reads the current value, opens the picker, and saves the selection back to this field automatically. |
Opens the picker without connecting it to the manifest. Use the callbacks to preview and apply the color yourself.
| Name | Type | Description |
|---|---|---|
initialValue | string | Initial color to show when the picker opens, as a CSS color string. |
mode | string[] | Color modes to offer. Defaults to ['solid']. Include 'gradient' to also allow gradients. |
showBrand | boolean | Whether to show the site's brand color palette. |
showCustom | boolean | Whether to show the custom color input. |
showAdvancedSettings | boolean | Whether to show the advanced settings panel. |
showOpacity | boolean | Whether to show the opacity slider. |
position | object | Screen position { x, y } where the picker should open. |
onChange | function | Called with the color string on every change while the picker is open. |
onApply | function | Called with the color string when the Wix user confirms a selection. |
onClose | function | Called when the picker closes, whether or not a color was confirmed. |
onCancel | function | Called when the Wix user cancels without confirming a selection. |
Promise<string | undefined>
When called with a manifest key, resolves with the updated color value once it's applied. When called with explicit options, use the onChange and onApply callbacks to receive color values as the Wix user interacts with the picker.
Last updated: 8 September 2026