Colour

A colour attribute value after parsing: a named hue at a tone, neutral, or a literal hex or RGB colour.

@internote/canvas-sdkType
On this page
import { Colour } from '@internote/canvas-sdk';

parseColour produces one from the text an author wrote, and writtenColour turns one back into that text. Switch on kind to tell the forms apart, or pass it to resolvedColourCss for CSS.

#Signature

HueColour | NeutralColour | LiteralColour

#Example

parseColour('light-blue'); // { kind: 'hue', hue: 'blue', tone: 'light' }
parseColour('neutral');    // { kind: 'neutral' }
parseColour('hex(0064FA)'); // { kind: 'literal', css: '#0064fa' }

Declared in packages/canvas-sdk/src/paint/colour.ts:397.

Last updated