Skip to content

Repository files navigation

Kireix

Kireix is a production-ready, framework-agnostic theme engine for applications, documentation sites, component libraries, and static websites.

It provides a validated theme registry, semantic CSS variables, light and dark appearances, safe lazy loading, persistence helpers, and SSR utilities with zero runtime dependencies.

Install

npm install @blcklab/kireix

Quick start

import {
  createKireix,
  createThemeRegistry,
  premiumThemePlugin,
} from '@blcklab/kireix'

const registry = createThemeRegistry()
registry.register(premiumThemePlugin)

const kireix = createKireix({
  registry,
  target: document.documentElement,
  theme: 'kireix-aurora',
  mode: 'system',
})

kireix.apply()

Use the generated semantic variables from any CSS system:

body {
  color: var(--kireix-text);
  background: var(--kireix-canvas);
  font-family: var(--kireix-font-sans);
}

.button {
  color: var(--kireix-on-accent);
  background: var(--kireix-accent);
  border-radius: var(--kireix-radius-control);
}

Highlights

  • Zero runtime dependencies.
  • Framework-agnostic and SSR-safe.
  • ESM, CommonJS, and TypeScript declarations.
  • Transactional plugin registration and inheritance validation.
  • Safe plugin ownership, replacement, and unregistration.
  • Allowlisted lazy loading with concurrent-load deduplication.
  • Race-safe theme changes and reactive system appearance.
  • Semantic CSS variables and native color-scheme support.
  • Optional no-flash SSR and local-storage helpers.
  • Twelve coordinated premium themes.

Documentation

Read the complete production documentation in /docs:

Package entry points

@blcklab/kireix
@blcklab/kireix/core
@blcklab/kireix/catalog
@blcklab/kireix/presets
@blcklab/kireix/ssr
@blcklab/kireix/persistence

Use direct subpath imports when a consumer needs only part of the package:

import { createThemeRegistry } from '@blcklab/kireix/core'
import { premiumThemePlugin } from '@blcklab/kireix/presets'

License

MIT

About

No description, website, or topics provided.

Resources

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages