Module

server.component_preview

Component preview server utilities.

Discovers component manifests and renders template partials with demo contexts.

Manifest format (YAML):

name: "Card" template: "partials/card.html" variants:

  • id: "default" name: "Default" context: title: "Hello"

Classes

ComponentPreviewServer
5

Methods 4

discover_components
0 list[dict[str, Any]]
def discover_components(self) -> list[dict[str, Any]]
Returns

list[dict[str, Any]]

render_component
2 str
def render_component(self, template_rel: str, context: dict[str, Any]) -> str
Parameters 2
template_rel str
context dict[str, Any]
Returns

str

list_page
1 str
def list_page(self, base_path: str = '/__bengal_components__/') -> str
Parameters 1
base_path str
Returns

str

view_page
2 str
def view_page(self, comp_id: str, variant_id: str | None) -> str
Parameters 2
comp_id str
variant_id str | None
Returns

str

Internal Methods 1
__init__
1 None
def __init__(self, site: Site) -> None
Parameters 1
site Site

Functions

discover_components
Discover components using a temporary server instance (compat shim).
1 list[dict[str, Any]]
def discover_components(site: Site) -> list[dict[str, Any]]

Discover components using a temporary server instance (compat shim).

Parameters 1

Name Type Default Description
site Site

Returns

list[dict[str, Any]]