Public API Index¶

Every symbol exported from pyjinhx (__all__) is listed below with a one-line description and a link to detailed documentation.

These 11 symbols are the entire top-level public API; advanced/internal building blocks (e.g. oob_swaps, LoadCache, ClientBackend, the asset-resolver helpers, dev tooling) remain importable from their submodules — e.g. from pyjinhx.cache import LoadCache.

Components & rendering¶

Symbol	Description	Documentation
`BaseComponent`	Pydantic base class for UI components with Jinja templates	BaseComponent
`ReactiveComponent`	Base class for dependency-aware reactive components (`react={...}` class keyword + `load()` + `depends_on()`)	Reactive API
`Renderer`	Renders PascalCase tag strings and manages default Jinja environment	Renderer

App wiring¶

Symbol	Description	Documentation
`setup()`	Single-call process + optional FastAPI wiring	Configuration
`Registry`	Class and request-scoped instance registry	Registry

Reactive authoring¶

Symbol	Description	Documentation
`mutates()`	Decorator: invalidate cache and accumulate dirtied keys after mutation	Mutations, Keys & PjxContext
`MutationKey`	Base `StrEnum` for app-level reactive key constants	Mutations, Keys & PjxContext
`PjxKey`	Marker for `Annotated[..., PjxKey()]` fields stamped as `data-pjx-load`	Mutations, Keys & PjxContext
`PjxContext`	Opaque base dataclass for request-scoped `load()` data	Mutations, Keys & PjxContext

Configuration¶

Symbol	Description	Documentation
`PjxSettings`	Invalidation backend and reactive dev flags	Configuration
`AssetMode`	Enum: `INLINE`, `REFERENCE`, or `NONE`	Renderer

Conceptual guides¶

For usage patterns and tutorials, see:

Usage tiers — bare components through full reactive wiring
Reactivity — reactive components, OOB swaps, cache scopes
Client Backend — per-request header access for render()
Asset Collection — delivery modes, dedup, static serving
Build an App — end-to-end tutorial
FastAPI integration — request scope, lifespan, headers