Skip to content
color-kitnext
StartAPI
color-kit on GitHub
Start

Concepts

  • OKLCH-canonical
  • Requested vs displayed
  • Planes and queries
  • Gamut and tolerance
  • Contrast

Guides

  • Headless picker
  • React
  • Contrast-aware palettes
  • GPU and three.js
  • Performance

API

  • Overview
  • @pbroom/color-kit
      • ffunctionrelativeLuminance
      • ffunctioncontrastRatio
      • ffunctioncontrastAPCA
      • ffunctionmeetsAA
      • ffunctionmeetsAAA
      • ffunctioncontrastRegionPath
      • ffunctioncontrastRegionPaths
      • ffunctionclampContrastRegionSampling
      • TtypeContrastApcaPolarity
      • TtypeContrastApcaPreset
      • TtypeContrastApcaRole
      • TtypeContrastMetric
      • IinterfaceContrastOptions
      • TtypeContrastPrecision
      • TtypeContrastRegionLevel
      • IinterfaceContrastRegionPoint
      • IinterfaceContrastRegionPathOptions
      • IinterfaceContrastRegionSampling
  • @pbroom/color-kit/plane
  • @pbroom/color-kit/interop
  • @pbroom/color-kit/compute
  • @pbroom/color-kit/hct
  • @pbroom/color-kit/driver
  • @pbroom/color-kit/react
Map

@pbroom/color-kit/Contrast

ContrastMetric

Contrast metric for contrast regions: 'wcag' uses contrastRatio, 'apca' uses contrastAPCA.

typeimport type { ContrastMetric } from '@pbroom/color-kit';types.ts:13
type ContrastMetric = 'wcag' | 'apca';

Your display: detecting

MIT licensedSource