@snailicid3/color 🐌

Color math, parsing, conversion, and hex utilities powered by chroma.ts and colorjs.io.

Repository

• Github: @snailicid3/color • snailicid3
• CDN: jsdeliver

Author

👤 Gillian Tunney

• github
• email

Recommended package manager is pnpm

@snailicid3/color 🐌

This package provides color math, CSS color parsing, hex conversion, contrast calculation, and chroma utilities. It wraps chroma.ts and colorjs.io with a consistent API and adds branded HexColor types.

@snailicid3/color contains:

• Hex utilities — isHexColor, parseColorToHex, assertHexColor, toHex
• CSS color parsing — parseColorJS, isValidColor via colorjs.io
• Chroma utilities — colorUtils.isValidColor, colorUtils.getColor, colorUtils.complement, colorUtils.triad
• Contrast — apcaContrast, readableTextHex
• Types — HexColor, ColorJS, ColorTheme

Installation

#pnpm
$ pnpm add @snailicid3/color

#yarn
$ yarn add @snailicid3/color

#npm
$ npm install @snailicid3/color

Examples

Parse CSS colors to hex

import { isHexColor, parseColorToHex, isValidColor } from '@snailicid3/color'

isHexColor('#FF0000') // true
isHexColor('red') // false
isValidColor('red') // true
parseColorToHex('red') // '#FF0000'
parseColorToHex('#336699') // '#336699'

Chroma utilities

import { colorUtils } from '@snailicid3/color'

colorUtils.isValidColor('blue') // true
colorUtils.complement('red') // Color (180° hue rotation)

Accessible contrast

import { parseColorJS, readableTextHex } from '@snailicid3/color'

readableTextHex('#336699') // 'black' or 'white' based on APCA contrast