canvasUiColorTypeValidator • tldraw Docs

A validator for canvas UI color types.

This validator ensures that color values are one of the valid canvas UI color types defined in TL_CANVAS_UI_COLOR_TYPES. It provides runtime type checking for canvas UI color properties.

canvasUiColorTypeValidator: T.Validator<
  | 'accent'
  | 'black'
  | 'laser'
  | 'muted-1'
  | 'selection-fill'
  | 'selection-stroke'
  | 'white'
>

Example

import { canvasUiColorTypeValidator } from '@tldraw/tlschema'

// Validate a color value
try {
  const validColor = canvasUiColorTypeValidator.validate('accent')
  console.log('Valid color:', validColor)
} catch (error) {
  console.error('Invalid color:', error.message)
}