Skip to content

Studnicky/iridis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

313 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iridis: chromatic pipeline for dynamic palette derivation — OKLCH-native, contrast-enforced, schema-validated, plugin-extensible

iridis

Chromatic pipeline for dynamic palette derivation. OKLCH-native, contrast-enforced, schema-validated, plugin-extensible.

docs node license release

Documentation · Releases

Variable-input-count seed colors expand into role-resolved, contrast-enforced palettes via a sequenced task pipeline. The docs site runs the live engine against its own brand palette; every chrome and syntax token on the page is the output of engine.run().

  • Getting started — install, the smallest possible pipeline, the shape of the output.
  • Try it out — edit seed colors and a role schema in the browser; the page recomputes through the engine on every keystroke.
  • Pipeline, Role schemas, ColorRecord — engine concepts.
  • Contrast and Accessibility calculations — WCAG 2.1 AA/AAA, APCA Lc targets, CVD simulation and correction.
  • Recipes — end-to-end snippets for the CLI, cascading CSS variables, and the Vue + Capacitor sample app.
  • Reference — per-color-space pages (Hex, RGB, HSV, CMYK, OKLCH) and accessibility-standards pages (WCAG 2.1, APCA).

Packages

Core

  • @studnicky/iridis — Pluggable color derivation pipeline. Variable-input-count seed colors expand into role-resolved, contrast-enforced palettes via a sequenced task pipeline. Browser- and Node-safe.
  • @studnicky/iridis-cli — Command-line interface for running the pipeline against a config file and writing outputs to disk.

Accessibility

  • @studnicky/iridis-contrast — WCAG 2.1 AA/AAA, APCA, and color-vision-deficiency enforcement — checks, corrects, and (for CVD) simulates against a resolved palette.

Input

  • @studnicky/iridis-image — Extracts a palette from image pixels — histogram, dominant-color clustering, and harmonization tasks.

Output targets

Each ships as a separate plugin package; install only what you need.

Requirements

Node.js >= 24 (matches engines.node in package.json).

Install

npm install @studnicky/iridis

Output targets ship as separate plugin packages; install only what you need:

npm install @studnicky/iridis-stylesheet @studnicky/iridis-tailwind @studnicky/iridis-vscode

Develop

git clone https://github.com/Studnicky/iridis.git
cd iridis
npm install
npm run typecheck
npm test
cd site && npm run dev

iridis ships source, not a build step — typecheck is the closest equivalent to build in this workspace.

The docs/demo site lives in site/ — a Nuxt app that runs the real engine live against its own theme. See site/README.md.

License

MIT — see LICENSE.

Changelog

See CHANGELOG.md and the GitHub releases.

About

Chromatic math engine for dynamic color calculation

Resources

License

Stars

2 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors