selectColor()

Opens a color picker panel in the editor, prompting the user to select a color. This function is intended for use in the settings panel of a site widget or plugin implemented with a custom element.

Syntax

Copy
function selectColor(value: string, options: { onChange: (value: string) => void }): Promise<string>

Parameters

NameTypeDescription
valuestringOptional. Value of the associated color CSS property.
optionsSelectColorOptionsOptional. Options to use when opening the color picker panel.

SelectColorOptions object

Copy
{ onChange: (value: string) => void }
NameTypeDescription
onChangeFunctionOptional. Callback function invoked when the color selection changes. It receives the updated color value as a parameter.

Returns

Promise<string>

The color selected by the user.

Example

Copy
import { editor, inputs } from "@wix/editor"; import { createClient } from "@wix/sdk"; const client = createClient({ host: editor.host(), modules: { inputs }, }); async function selectColor(color) { const response = await client.inputs.selectColor(color, { onChange: (value) => { console.log("New color: ", value); }, }); }
Did this help?