pyjinhx 0.4.2

UI components for Python using Pydantic and Jinja2 templates

PyJinHx

Build reusable, type-safe UI components for template-based web apps in Python. PyJinHx combines Pydantic models with Jinja2 templates to give you template discovery, component composition, and JavaScript bundling.

• Automatic Template Discovery: Place templates next to component files—no manual paths
• JavaScript Bundling: Automatically collects and bundles .js files from component directories
• Composability: Nest components easily—works with single components, lists, and dictionaries
• Flexible: Use Python classes for reusable components, HTML syntax for quick page composition
• Type Safety: Pydantic models provide validation and IDE support

Installation

pip install pyjinhx

Example

This single example shows the full setup (Python classes + templates) and both ways to render:

• Python-side: instantiate a component class and call .render().
• Template-side: render an HTML-like string with custom tags via Renderer.

Step 1: Define component classes

# components/ui/button.py
from pyjinhx import BaseComponent


class Button(BaseComponent):
    id: str
    text: str
    variant: str = "default"

# components/ui/card.py
from pyjinhx import BaseComponent
from components.ui.button import Button


class Card(BaseComponent):
    id: str
    title: str
    action_button: Button

# components/ui/page.py
from pyjinhx import BaseComponent
from components.ui.card import Card


class Page(BaseComponent):
    id: str
    title: str
    main_card: Card

Step 2: Create templates (auto-discovered next to the class files)

<!-- components/ui/button.html -->
<button id="{{ id }}" class="btn btn-{{ variant }}">{{ text }}</button>

<!-- components/ui/card.html -->
<div id="{{ id }}" class="card">
  <h2>{{ title }}</h2>
  <div class="action">{{ action_button }}</div>
</div>

<!-- components/ui/page.html -->
<main id="{{ id }}">
  <h1>{{ title }}</h1>
  {{ main_card }}
</main>

Step 3A: Python-side rendering (BaseComponent.render())

from components.ui.button import Button
from components.ui.card import Card
from components.ui.page import Page

page = Page(
    id="home",
    title="Welcome",
    main_card=Card(
        id="hero",
        title="Get Started",
        action_button=Button(id="cta", text="Sign up", variant="primary"),
    ),
)

html = page.render()

Step 3B: Template-side rendering (Renderer.render(source))

from pyjinhx import Renderer

# Set template directory once
Renderer.set_default_environment("./components")

# Use the default renderer with auto_id enabled
html = Renderer.get_default_renderer(auto_id=True).render(
    """
    <Page title="Welcome">
      <Card title="Get Started">
        <Button text="Sign up" variant="primary"/>
      </Card>
    </Page>
    """
)

Template-side rendering supports:

• Type safety for registered classes: if Button(BaseComponent) exists, its fields are validated when <Button .../> is instantiated.
• Generic tags: if there is no registered class, a generic BaseComponent is used as long as the template file can be found.

JavaScript & extra assets

• Component-local JS: if a component class MyWidget has a sibling file my-widget.js, it is auto-collected and injected once at the root render level.
• Extra JS: pass js=[...] with file paths; missing files are ignored.
• Extra HTML files: pass html=[...] with file paths; they are rendered and exposed in the template context by filename stem (e.g. extra_content.html → extra_content.html wrapper). Missing files raise FileNotFoundError.

Optional UI components ship in pyjinhx.builtins. Full reference (fields, px- CSS classes, --px-* tokens, template fallback): docs/guide/builtins.md, or the published site under Guide → Built-in UI components.

FastAPI + HTMX example

Component class

# components/ui/button.py
from pyjinhx import BaseComponent


class Button(BaseComponent):
    id: str
    text: str

Component template (with HTMX)

<!-- components/ui/button.html -->
<button
  id="{{ id }}"
  hx-post="/clicked"
  hx-vals='{"button_id": "{{ id }}"}'
  hx-target="#click-result"
  hx-swap="innerHTML"
>
  {{ text }}
</button>

FastAPI app (two routes)

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

from components.ui.button import Button

app = FastAPI()


@app.get("/button", response_class=HTMLResponse)
def button() -> str:
    return (
        Button(id="save-btn", text="Click me").render()
        + '<div id="click-result"></div>'
    )


@app.post("/clicked", response_class=HTMLResponse)
def clicked(button_id: str = "unknown") -> str:
    return f"Clicked: {button_id}"

Design decisions

• The builtins gallery (tests/integration/app.py) exposes GET /sse/panel-demo: a slow HTMX SSE stream wired to the Beta slot of the demo Panel, so you can confirm hidden slots stay mounted and keep receiving events. Coverage lives in tests/integration/test_panel_sse.py (runs a short-lived uvicorn bound to localhost).
• Test suite imports are stabilized by adding the project root to sys.path in tests/conftest.py. This keeps absolute imports like from pyjinhx import ... and from tests.ui... working across different pytest import modes and Python runners.
• Optional builtins (pyjinhx.builtins) ship twenty UI components with sibling templates, CSS, and JS where needed; documentation lives in docs/guide/builtins.md. Importing pyjinhx.builtins registers those classes with the global registry like any other BaseComponent subclass.
• Built-in components live under site-packages; Jinja’s FileSystemLoader does not load templates outside the configured root. The renderer therefore falls back to reading adjacent template files from disk for classes in the pyjinhx.builtins package when normal relative lookup fails, so your app’s loader can stay pointed at your own template directory.
• Co-located JS/CSS names: Auto-collection looks for pascal_case_to_kebab_case(ClassName) + ".js" / ".css" next to the class (e.g. TabGroup → tab-group.js, PanelTrigger → panel-trigger.css, Panel → panel.js / panel.css). Using snake_case filenames such as tab_group.js will not be picked up; templates may still resolve via both snake and kebab candidates.
• Built-in template slots: Wrappers that accept arbitrary inner markup use the field and Jinja name content ({{ content }}) — e.g. Notification, Popover, PanelTrigger. Shell-style blocks use body (Modal, Card, Alert, Drawer). Short static chrome uses label (Badge, Breadcrumb, TabGroup tab titles).