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
  • @pbroom/color-kit/plane
      • TtypePlane
      • IinterfacePlaneAxis
      • IinterfacePlaneBoundaryPoint
      • TtypePlaneChannelFor
      • IinterfacePlaneChromaBandQuery
      • IinterfacePlaneChromaBandResult
      • IinterfacePlaneColorPoint
      • TtypePlaneContrastBoundaryQuery
      • IinterfacePlaneContrastBoundaryResult
      • TtypePlaneContrastRegionQuery
      • IinterfacePlaneContrastRegionResult
      • IinterfacePlaneDefinition
      • TtypePlaneDefinitionFor
      • TtypePlaneFixedInput
      • IinterfacePlaneFallbackPointQuery
      • IinterfacePlaneFallbackPointResult
      • IinterfacePlaneGamutBoundaryQuery
      • IinterfacePlaneGamutBoundaryResult
      • IinterfacePlaneGamutRegionQuery
      • IinterfacePlaneGamutRegionResult
      • IinterfacePlaneGradientQuery
      • IinterfacePlaneGradientResult
      • IinterfacePlaneQueryInspection
      • TtypePlaneModelColor
      • TtypePlaneModel
      • IinterfacePlanePoint
      • TtypePlaneQuery
      • TtypePlaneQueryResult
      • IinterfacePlaneRegion
      • IinterfacePlaneRegionPoint
      • IinterfaceResolvedPlaneAxis
      • IinterfaceResolvedPlaneDefinition
  • @pbroom/color-kit/interop
  • @pbroom/color-kit/compute
  • @pbroom/color-kit/hct
  • @pbroom/color-kit/driver
  • @pbroom/color-kit/react
Map

@pbroom/color-kit/plane/Types

PlaneQueryResult

Any plane query result, discriminated by kind (matches the query's).

typeimport type { PlaneQueryResult } from '@pbroom/color-kit/plane';types.ts:536
type PlaneQueryResult =
  | PlaneGamutBoundaryResult
  | PlaneGamutRegionResult
  | PlaneContrastBoundaryResult
  | PlaneContrastRegionResult
  | PlaneChromaBandResult
  | PlaneFallbackPointResult
  | PlaneGradientResult;

Also exported from

  • @pbroom/color-kitthe same declaration, re-exported

Your display: detecting

MIT licensedSource