Metadata-Version: 2.5
Name: spaday-blueprint
Version: 0.2.0
Summary: Blueprint for spaday
Project-URL: Repository, https://github.com/1kbgz/spaday-blueprint
Project-URL: Homepage, https://github.com/1kbgz/spaday-blueprint
Author-email: 1kbgz <dev@1kbgz.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: spaday<1.0,>=0.10.0
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: hatch-js; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: httpx; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pydantic>=2; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: starlette; extra == 'develop'
Requires-Dist: transports<0.9,>=0.8.6; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: uvicorn; extra == 'develop'
Requires-Dist: websockets; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Provides-Extra: examples
Requires-Dist: pydantic>=2; extra == 'examples'
Requires-Dist: starlette; extra == 'examples'
Requires-Dist: transports<0.9,>=0.8.6; extra == 'examples'
Requires-Dist: uvicorn; extra == 'examples'
Requires-Dist: websockets; extra == 'examples'
Description-Content-Type: text/markdown

<a href="https://github.com/1kbgz/spaday-blueprint">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/1kbgz/spaday-blueprint/raw/main/docs/img/logo-dark.webp?raw=true">
    <img alt="spaday-blueprint logo, a component blueprint inside a browser window" src="https://github.com/1kbgz/spaday-blueprint/raw/main/docs/img/logo-light.webp?raw=true" width="1200">
  </picture>
</a>

Typed [Blueprint](https://blueprintui.dev) components and browser assets for [spaday](https://github.com/1kbgz/spaday).

[![Build Status](https://github.com/1kbgz/spaday-blueprint/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/spaday-blueprint/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/1kbgz/spaday-blueprint/branch/main/graph/badge.svg)](https://codecov.io/gh/1kbgz/spaday-blueprint)
[![License](https://img.shields.io/github/license/1kbgz/spaday-blueprint)](https://github.com/1kbgz/spaday-blueprint)
[![PyPI](https://img.shields.io/pypi/v/spaday-blueprint.svg)](https://pypi.python.org/pypi/spaday-blueprint)

[![Preview of Blueprint components in spaday rendering a release console](https://raw.githubusercontent.com/1kbgz/spaday-blueprint/main/docs/img/preview.webp)](https://1kbgz.github.io/spaday-blueprint/lite/)

## Overview

```python
from spaday import SetField, serve
from spaday_blueprint import BpBadge, BpButton, BpCard

page = BpCard(
    BpButton(action="primary", status="success").text("Approve").on("click", SetField("state", "approved")),
    BpBadge().bind("textContent", "state"),
)
serve(page, packages=["blueprint"], store={"state": "pending"})
```

Every Blueprint element has a typed class — 80 from `@blueprintui/components` and `BpIcon` from
`@blueprintui/icons` — generated from their Custom Elements Manifests, so props, events and slots
are checked when you author the tree. Installing the package does not inject assets; select it with
`packages=["blueprint"]` or pass the exported `package` descriptor.

## Generic controls

Selecting this package renders 12 of the 13 controls in `spaday.ui` as Blueprint elements. The
mapping is exported as `DESIGN`. `RadioGroup` uses spaday's marked native fallback because Blueprint
provides individual radio controls but no group with a value API. The shared conformance page checks
the complete control set, including that fallback.

## Browser examples

- [Open the standard app](https://1kbgz.github.io/spaday-blueprint/lite/) ([source](spaday_blueprint/example.py)).
- [Open the complete component gallery](https://1kbgz.github.io/spaday-blueprint/lite/?example=gallery) ([source](spaday_blueprint/gallery.py)).

Both run Python locally through Pyodide; no install or server is required.

## Run examples locally

```bash
python -m pip install -e ".[examples]"
python -m spaday_blueprint.example
python -m spaday_blueprint.gallery
```

Open `http://127.0.0.1:8023` for the standard release-console app or `http://127.0.0.1:8024` for the
component gallery. The standard app includes service metrics streamed from Python, endpoint-backed
restart and deploy actions, rollout progress, incident handling, bound forms, tabs, overlays, and shared
dark-theme state. The gallery documents every generated Blueprint component and provides a highlighted
Python snippet for each component family, including a working number stepper
instead of rendering that element.

Both pass the local package descriptor directly, so they do not install or resolve the integration from
GitHub.

## Theming

The stylesheet maps spaday's `--spa-*` shell palette onto Blueprint's own tokens, so restyling
Blueprint restyles the shell and every other spaday component package with it. `TOKENS` lists the
Blueprint tokens wired to the palette, each settable through `css()`:

```python
App().css(bp_status_accent_background_200="#0C4253")
```

Blueprint's dark theme follows spaday's page mode: a `wa-dark` class on the root (for example
`App(...).bind_root_class("wa-dark", "dark")`) or on any island switches it, and `wa-light` flips a
nested island back. Blueprint's own `bp-theme="dark"` attribute works as well.

## Sharing Blueprint with your own library

Blueprint registers global custom element names, so a second copy on the page throws from
`customElements.define`. The package serves Blueprint's modules under their own bare specifiers —
`@blueprintui/components/button`, `@blueprintui/components/include/button.js`,
`@blueprintui/icons/shapes/user.js` and the rest of their exports — through the page's import map.
A library built on Blueprint that leaves those imports out of its bundle
(`external: ["@blueprintui/components", "@blueprintui/icons"]` with esbuild) gets this copy, and
nothing registers twice.

## Known issues

- Blueprint 2.20's `bp-number-stepper` sets its `step` attribute from its constructor. The served
  module defers that default until connection so standards-compliant `document.createElement` works.
- `@blueprintui/icons`' root module omits the `BpIcon` export its types declare; the served copy
  restores it, since Blueprint's own components import it from there.

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
