API Reference Pote v#2.2.0

Copy Markdown View Source

Modules

Pote — canonical color types, default palette, and top-level helpers.

Structured representation of a color in all supported formats.

Unified map of basic color names to RGB values.

Color conversion module.

Advanced color conversions for special color spaces.

Conversions to/from CMYK.

Conversions to/from HSL.

Conversions to/from HSV.

Conversions to/from HWB (Hue, Whiteness, Blackness).

Conversions to/from RGB.

Conversions to/from XTerm256.

Behaviour for color format handlers.

ANSI format for basic terminal colours.

ARGB format for colours ({a, r, g, b}).

Atom format for colours by name.

Alias for Pote.Format for backward compatibility.

CMYK format for colours ({c, m, y, k}). All values: 0-100 (%)

HSL format for colours ({h, s, l}). h: 0-360 (degrees), s: 0-100 (%), l: 0-100 (%)

HSV format for colours ({h, s, v}). h: 0-360 (degrees), s: 0-100 (%), v: 0-100 (%)

Hex format for colours (#RRGGBB).

RGB format for colours ({r, g, b}).

XTerm256 format for colours (0-255).

Linear and multi-stop color gradient generation.

Color harmony generation based on color theory principles.

Color orchestration module for parsing, converting, and formatting colors.

Handles cleaning user input for colour formats.

A theme system that any host application can opt into.

Built-in theme templates that ship with Pote.

The theme struct — name, optional description, and the colour map.

Validates color format values against their specification.