chirp-ui API Reference

Icon registry: semantic names → Unicode glyphs for chirp-ui components.

Use theicon filter to resolve names in templates: {{ "status" | icon }}→ ◎. Unknown names…

Typed config-schema → form-field projection for chirp-ui.

Deliberately modeled onchirp_ui.grid_stateand chirp_ui.route_tabs: stdlib + dataclasses only, no import chirpand noimport kida. Fully unit-testable…

CSS custom property catalog — machine-readable index of --chirpui-* tokens.

EachTokenDefrecords a single CSS custom property: its name, semantic category, and scope (global or a component…

Alpine runtime detection for chirp-ui.

chirp-ui has a small, enumerable set of macros that require chirpui-alpine.jsto work at runtime (theme toggle, dialogs, dropdowns, collapsible sidebar, etc). When…

Manifest-driven CSS subset selection for chirp-ui (issue #205).

The shippedchirpui.cssconcatenates every authoring partial (~350+ components). Consumers that use a handful of macros can emit a fraction…

Route-family tab helpers for chirp-ui route_tabs component.

Tab item: dict or object withhref, optional match (default "exact"). Full dict shape (from ChirpTabItem via _tab_item_to_shell_dict…

MCP server over the chirp-ui manifest — agent-native registry distribution.

Requires the optionalmcpextra::

pip install "chirp-ui[mcp]"
chirp-ui mcp

Tools expose the same manifest surface aschirp-ui…

chirp-ui — Reusable Kida component library for Chirp.

Headless, htmx-native, zero JavaScript. Install and import::

pip install chirp-ui {%% from "chirpui/card.html" import card %%} {%% from "chirpui/modal.html" import…

Server-driven data-grid state helpers for chirp-ui (issue #200).

Deliberately modeled onchirp_ui.route_tabs: stdlib + dataclasses only, noimport chirp and no import kida. The module is…

AST introspection for{% def %}macros — internal.

Wrapskida.lexer + kida.parserto extract per-macro parameter metadata without compiling the template (so no chirp-ui filter stubs are…

Design system introspection — dump the chirp-ui API surface.

Usage::

python -m chirp_ui.inspect # JSON report python -m chirp_ui.inspect --summary # compact table python -m chirp_ui.inspect --tokens #…

Kida preview environment for offline macro rendering.

Used by the blocks-gallery generator and component render tests. Mirrors the Chirp runtime stubs registered intests/conftest.pyso manifest usage snippets…

Declarative keyboard-shortcut catalog for chirp-ui.

The catalog is the single source of truth:shortcuts_help.htmlrenders the help modal from it, and thechirpuiShortcutsAlpine factory dispatches from the…

Registry-backed blocks gallery — copy-paste snippets and live previews.

Generates the manifest-driven blocks catalog consumed by the component showcase and freshness-gated in CI (scripts/build_blocks_gallery.py).

Template filters required by chirp-ui components.

These match Chirp's filter API so chirp-ui works with any Chirp version. Register viaregister_filters() when using Chirp.

Everything not in …

Agent-groundable manifest of the chirp-ui component surface.

This module publishes the component registry (chirp_ui.components.COMPONENTS pluschirp_ui.tokens.TOKEN_CATALOG) as a stable JSON snapshot. AI agents and docs tooling…

Component descriptors — single source of truth for chirp-ui's BEM API surface.

EachComponentDescriptordeclares the full public contract of a component: block name, allowed variants (legacy/mutually exclusive),…

Framework-neutral package metadata for Chirp UI consumers.

Frameworks and static-site generators can consume this module to discover the public Chirp UI template root, static assets, and manifest path…

chirp-ui variant validation — strict mode, warning infrastructure, and registries.

When strict mode is enabled (viaset_strict()), validation warnings escalate toValueError. In non-strict mode, _warn…

Layout-affinity vocabulary for recipe-level workspace contracts.

The current layout-affinity contract is intentionally narrow: rendered templates may emit documenteddata-chirpui-*attributes, and parent primitives may resolve those attributes inside…

Fuzzy component discovery over the shipped manifest —python -m chirp_ui find.

Sprint 6 of the agent-grounding-depth epic. The manifest is the registry projection; this module turns…

Text-fragment deep-link helper for chirp-ui citation UI.

Pure-URL, stdlib-only (Chirp-agnostic, like route_tabs / grid_state). Builds#:~:text=scroll-to-text-fragment links.

python -m chirp_uidispatch — subcommand front door.

Currently a single subcommand (find) plus a pointer to the existing python -m chirp_ui.manifestentry point. New subcommands…

Immutable catalog of token-only Chirp UI theme packs.

Sliding-pill nav indicator helpers (#255).

Server-side CSS custom-property estimates for first paint; shell runtime syncPill()refines to measured pixels on client navigation.

Browse Python API documentation by package.