Skip to main content

Named UI role recipes (panels, chrome, insets) for FastHTML applications — a stable abstraction layer over DaisyUI and Tailwind primitives.

Project description

cjm-fasthtml-design-system

Install

pip install cjm_fasthtml_design_system

Role in the Multi-Workflow Pipeline

This library sits between UI-bearing consumer libraries and the underlying styling primitives:

Consumers (page-centric libraries, host apps, demo apps)
    ↓ depend on
Layout primitives (cjm-fasthtml-app-core: page chrome, column+queue, toolbar)
    ↓ depend on
Design-system recipes (THIS LIBRARY: panels, chrome, insets, ...)
    ↓ depend on
Styling primitives (cjm-fasthtml-daisyui, cjm-fasthtml-tailwind: tokens)

Consumers import named roles (panels.dashboard_tile, chrome.column_header) instead of reaching for styling tokens directly. This makes coordinated styling changes a single-file edit in this library rather than N-file edits across every consumer, and keeps the role API stable across a potential future FastHTML-to-native port.

Design System Document

The multi-workflow design system is split between this library’s notebooks (codified conventions as running code) and a pointer-first Markdown document (cross-cutting content that cannot be codified):

  • Codified conventions — the library is authoritative. V10 panel / chrome / inset variants are codified today as running code with CI-asserted test guards. Future conventions (V1 buttons, G6 icon sizes, G8 destructive-confirm, text-role tiers) will land here as additional notebooks.
  • Non-codifiable content — the doc is authoritative. Principles (P1–P12), the Refinement Procedure, open gaps, open questions, priority tasks by workflow phase, and cross-library interaction / layout / component directories live in claude-docs/multi-workflow-design-system.md. The doc’s Conventions Directory references this library’s notebooks by convention ID.

Each codified convention maps to a notebook in nbs/:

Convention Notebook Module What it codifies
V10 Panel variants nbs/panels.ipynb cjm_fasthtml_design_system.panels P1–P5 full-panel recipes
V10 Chrome variants nbs/chrome.ipynb cjm_fasthtml_design_system.chrome C1–C2 column header/footer recipes
V10 Inset variants nbs/insets.ipynb cjm_fasthtml_design_system.insets I1 opacity-modulated inset recipes

The 2026-04-20 content-heavy inventory is preserved as a historical snapshot at claude-docs/multi-workflow-design-system-2026-04-23_11-53-14.md; the pointer-first successor at claude-docs/multi-workflow-design-system.md replaced it on 2026-04-23 as part of this library’s Phase 3 restructure. See claude-docs/cjm-fasthtml-design-system-bootstrap-plan.md Appendix C for the restructure rationale.

Usage

Every recipe module exports a module-level instance of a frozen dataclass. Consumers import the instance and use attribute access:

from fasthtml.common import Div

from cjm_fasthtml_design_system.panels import panels
from cjm_fasthtml_design_system.chrome import chrome
from cjm_fasthtml_design_system.insets import insets

from cjm_fasthtml_tailwind.core.base import combine_classes
from cjm_fasthtml_tailwind.utilities.sizing import w
from cjm_fasthtml_tailwind.utilities.spacing import m

# Stand-alone use
Div(..., cls=panels.structural_container)

# Composable with site-specific modifiers
Div(..., cls=combine_classes(w.full, m.t(4), panels.content_panel))

# Chrome sits inside a panel
Div(
    Div('Header', cls=chrome.column_header),
    Div('Body'),
    Div('Status', cls=chrome.column_footer),
    cls=panels.structural_container,
)

Why frozen dataclass: renaming a field is a breaking change announced in the type, which enforces namespace-as-public-contract discipline. Consumers can’t accidentally mutate roles at runtime. A native-platform port replaces the instantiation while keeping the class shape stable; consumer imports never move.

Why per-category modules: panels, chrome, and insets will evolve at different cadences. Keeping them separate means a change to one category doesn’t force re-export of the others.

Extending the Library

When a new convention accrues enough evidence to codify (e.g., G6 icon-size roles, V1 button-role codification, G8 destructive-confirm composition — each currently tracked in the design-system doc’s Open Gaps), add a new notebook under nbs/ following the V10 pattern:

  1. Create nbs/<category>.ipynb with #| default_exp <category>.
  2. Define a frozen XVariants dataclass enumerating the roles.
  3. Instantiate it at module scope as a singleton (e.g., x_variants = XVariants(...)).
  4. Add attribute-level tests asserting each role contains its expected primitives.
  5. Update this index’s convention-to-notebook table and add a matching pointer row to the design-system doc’s Conventions Directory.

The recipe layer’s public contract is the set of dataclass class names and field names. Internal composition (which primitives each recipe combines) can evolve without breaking consumers as long as the field names stay stable. Notebook preambles should declare the convention ID and state the rationale directly — the design-system doc references the library, not vice versa.

Project Structure

nbs/
├── chrome.ipynb # Named chrome-role recipes for header and footer bands that accompany a content panel. Chrome is a `base_200` fill + rounded-corners band with intrinsic padding — no border of its own. When placed as a page-level sibling of a panel, the panel's border handles the between-surfaces separator; chrome's fill + radius read it as a self-contained sibling surface against the page's `base_100`.
├── icons.ipynb  # Named icon-size-role recipes for the `lucide_icon(name, size=...)` factory. Each role maps a structural placement context (text-labeled button, ghost-styled standalone trigger, section-header decoration, empty-state illustration, etc.) to a size value the consumer passes through to `lucide_icon`. Two sizing strategies coexist in the catalog: fixed numeric (icon owns its absolute size) and container-fill (`"full"`, parent button's intrinsic padding owns the size).
├── insets.ipynb # Named inset-role recipes for opacity-modulated low-emphasis regions *inside* a panel. Insets never stand alone — they're sub-regions that need visual grouping without adding a second panel border.
└── panels.ipynb # Named panel-role recipes for full content containers with `border_radius.box`. Each role composes a specific set of DaisyUI and Tailwind primitives and exposes a stable attribute-access API for consumers.

Total: 4 notebooks

Module Dependencies

graph LR
    chrome[chrome<br/>Chrome Variants]
    icons[icons<br/>Icon Size Roles]
    insets[insets<br/>Inset Variants]
    panels[panels<br/>Panel Variants]

No cross-module dependencies detected.

CLI Reference

No CLI commands found in this project.

Module Overview

Detailed documentation for each module in the project:

Chrome Variants (chrome.ipynb)

Named chrome-role recipes for header and footer bands that accompany a content panel. Chrome is a base_200 fill + rounded-corners band with intrinsic padding — no border of its own. When placed as a page-level sibling of a panel, the panel’s border handles the between-surfaces separator; chrome’s fill + radius read it as a self-contained sibling surface against the page’s base_100.

Import

from cjm_fasthtml_design_system.chrome import (
    chrome,
    ChromeVariants
)

Classes

class ChromeVariants:
    "Named chrome-role recipes (V10). Header/footer bands with base_200 fill and rounded corners (no own border)."

Icon Size Roles (icons.ipynb)

Named icon-size-role recipes for the lucide_icon(name, size=...) factory. Each role maps a structural placement context (text-labeled button, ghost-styled standalone trigger, section-header decoration, empty-state illustration, etc.) to a size value the consumer passes through to lucide_icon. Two sizing strategies coexist in the catalog: fixed numeric (icon owns its absolute size) and container-fill ("full", parent button’s intrinsic padding owns the size).

Import

from cjm_fasthtml_design_system.icons import (
    IconSize,
    icons,
    IconRoles
)

Classes

class IconRoles:
    "Named icon-size-role recipes (V11). Each field maps a structural placement to a size value passed to `lucide_icon(name, size=...)`."

Inset Variants (insets.ipynb)

Named inset-role recipes for opacity-modulated low-emphasis regions inside a panel. Insets never stand alone — they’re sub-regions that need visual grouping without adding a second panel border.

Import

from cjm_fasthtml_design_system.insets import (
    insets,
    InsetVariants
)

Classes

class InsetVariants:
    "Named inset-role recipes (V10). Opacity-modulated low-emphasis regions inside a panel."

Panel Variants (panels.ipynb)

Named panel-role recipes for full content containers with border_radius.box. Each role composes a specific set of DaisyUI and Tailwind primitives and exposes a stable attribute-access API for consumers.

Import

from cjm_fasthtml_design_system.panels import (
    panels,
    PanelVariants
)

Classes

class PanelVariants:
    "Named panel-role recipes (V10). Each field is a pre-composed CSS class string."

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cjm_fasthtml_design_system-0.0.5.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cjm_fasthtml_design_system-0.0.5-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file cjm_fasthtml_design_system-0.0.5.tar.gz.

File metadata

File hashes

Hashes for cjm_fasthtml_design_system-0.0.5.tar.gz
Algorithm Hash digest
SHA256 5c8030c61b3d617f17dac4cb4f7576f91ce6199375d1e5c7266efc5fffdf064f
MD5 ec718cc98820450e252b5b820154e19d
BLAKE2b-256 aa850faac77a13b6cc50ed34a0f1713d291241f2b7e30d29b5435eec193ca65c

See more details on using hashes here.

File details

Details for the file cjm_fasthtml_design_system-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for cjm_fasthtml_design_system-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e23aed2c14f1537ac96a091ef7ff4d690950c99e35541606d78a3869fa430d88
MD5 475bec80d85015ab91683dac75601dc8
BLAKE2b-256 f2d2ef8ba70b24a810ff645e6a9bc91dc57e8f790027c11af2d6ae419690659e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page