Skip to main content

Interface: ReadyImageColorAdjustmentControls

Properties​

HSL​

• HSL: HSL

An object containing the current HSL adjustment values for the selected image

Defined in​

packages/design-engine-react-components/src/hooks/useImageColorAdjustmentControls/useImageColorAdjustmentControls.ts:30


isEnabled​

• isEnabled: true

Boolean value for whether the color adjustment controls are currently enabled from an image item being selected. The HSL, setHSL and onCommit properties will only be present if this value is true and status === 'ready'

Defined in​

packages/design-engine-react-components/src/hooks/useImageColorAdjustmentControls/useImageColorAdjustmentControls.ts:26


onCommit​

• onCommit: () => void

Type declaration​

▸ (): void

Commits the current HSL adjustments to the document by executing the setColorAdjustments command

Returns​

void

Defined in​

packages/design-engine-react-components/src/hooks/useImageColorAdjustmentControls/useImageColorAdjustmentControls.ts:34


setHSL​

• setHSL: (hsl: Partial<HSL>) => void

Type declaration​

▸ (hsl): void

A funtion to set some or all of the selected image's HSL adjustments

Parameters​
NameType
hslPartial<HSL>
Returns​

void

Defined in​

packages/design-engine-react-components/src/hooks/useImageColorAdjustmentControls/useImageColorAdjustmentControls.ts:32


status​

• status: "ready"

A string representing the async readiness status of the image's color controls. Will be 'loading' initially, 'failed' in the case of an error, and 'ready' after an image's dominant colors have been successfully calculated and HSL values can be changed.

Defined in​

packages/design-engine-react-components/src/hooks/useImageColorAdjustmentControls/useImageColorAdjustmentControls.ts:28