Skip to main content

Function: isColorString()

isColorString(color): color is `rgb(${number}, ${number}, ${number})` | `rgba(${number}, ${number}, ${number}, ${number})` | `#${string}`

Defined in: utils/system.ts:139

Type guard to check if a value is a valid color string (RGB, RGBA, or HEX).

Parameters

color

The value to check

ThemeMap | ColorValue

Returns

color is `rgb(${number}, ${number}, ${number})` | `rgba(${number}, ${number}, ${number}, ${number})` | `#${string}`

True if the value is a valid color string

Example

isColorString('#FF0000'); // true
isColorString('rgb(255, 0, 0)'); // true
isColorString('rgba(255, 0, 0, 0.5)'); // true
isColorString('red'); // false