Extension

Extension

Colorpicker extension class.

Constructor

new Extension(colorpicker, options)

Source:

Extension.js, line 8

Parameters:

Name	Type	Description
`colorpicker`	`Colorpicker`
`options`	`Object`

Members

colorpicker :Colorpicker

The colorpicker instance

Source:

Extension.js, line 18

Type:

Colorpicker

options :Object

Extension options

Source:

Extension.js, line 24

Type:

Object

Methods

onChange(event)

Method called after the colorpicker color is changed

Source:

Extension.js, line 90

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerChange

onCreate(event)

Method called after the colorpicker is created

Source:

Extension.js, line 60

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerCreate

onDestroy(event)

Method called after the colorpicker is destroyed

Source:

Extension.js, line 70

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerDestroy

onDisable(event)

Method called after the colorpicker is disabled

Source:

Extension.js, line 130

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerDisable

onEnable(event)

Method called after the colorpicker is enabled

Source:

Extension.js, line 140

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerEnable

onHide(event)

Method called after the colorpicker is hidden

Source:

Extension.js, line 110

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerHide

onInvalid(event)

Method called when the colorpicker color is invalid

Source:

Extension.js, line 100

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerInvalid

onShow(event)

Method called after the colorpicker is shown

Source:

Extension.js, line 120

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerShow

onUpdate(event)

Method called after the colorpicker is updated

Source:

Extension.js, line 80

Parameters:

Name	Type	Description
`event`	`Event`

Listens to Events:

Colorpicker#event:colorpickerUpdate

resolveColor(color, realColor) → {ColorItem|String|*}

Function called every time a new color needs to be created. Return false to skip this resolver and continue with other extensions' ones or return anything else to consider the color resolved.

Source:

Extension.js, line 50

Parameters:

Name	Type	Default	Description
`color`	`ColorItem` \| `String` \| `*`
`realColor`	`boolean`	true	if true, the color should resolve into a real (not named) color code

Returns:

Type:: ColorItem | String | *