Skip to main content
Version: Version 5 beta

Interface: ColorPickerInterface

Interface for the color picker popover.

Extends

  • EventHandlerInterface<"toggled" | "colorSelected" | "opacitySelected", EventMap[ColorPickerPopoverEvents]>

Properties

addEventListener()

addEventListener: (eventName, callback) => void

Adds an event listener for specified events.

Parameters

eventName: "toggled" | "colorSelected" | "opacitySelected"

callback: (active, top?, left?) => void | (color) => void | (opacity) => void

Returns

void

Inherited from

EventHandlerInterface.addEventListener


emitColorSelected()

emitColorSelected: (color) => void

Emits a color selected event for the color picker popover.

Parameters

color: `#${string}`

The selected color.

Returns

void

void


emitOpacitySelected()

emitOpacitySelected: (opacity) => void

Emits an opacity selected event for the color picker popover.

Parameters

opacity: number

The selected opacity.

Returns

void

void


emitToggled()

emitToggled: (active, top?, left?) => void

Emits a toggled event for the color picker popover.

Parameters

active: boolean

Whether the popover is active or not.

top?: number

The top position of the popover.

left?: number

The left position of the popover.

Returns

void

void


removeEventListener()

removeEventListener: (eventName, callback) => void

Removes an event listener for specified events.

Parameters

eventName: "toggled" | "colorSelected" | "opacitySelected"

callback: (active, top?, left?) => void | (color) => void | (opacity) => void

Returns

void

Inherited from

EventHandlerInterface.removeEventListener