betty.content_builders.box module

The box content plugin.

final class betty.content_builders.box.Box

Bases: Template, DataManufacturable[BoxData]

The box content builder plugin.

Plugin ID	box
Class	Box
Configuration	BoxData

__init__(content: Iterable[ContentBuilder], *, jinja: Environment, min_height: str | None = None, max_height: str | None = None, height: str | None = None, min_width: str | None = None, max_width: str | None = None, width: str | None = None)

async build_template(document: Document) → TemplateBuild

Build template data.

Return a template name, a tuple of a template name and template date to render it. Return None to prevent anything from being rendered at all.

new = <betty.requirement._RequirableDecorator object>

classmethod new_data_cls() → type[BoxData]

The object’s defined data class.

final class betty.content_builders.box.BoxData

Bases: Data, HasProps

Configuration for betty.content_builders.box.Box.

betty.content_builders.box:BoxData

__init__(content: ResolvablePluginManufacturerSequence[ContentBuilderDefinition, ContentBuilder], *, min_height: str | None = None, max_height: str | None = None, height: str | None = None, min_width: str | None = None, max_width: str | None = None, width: str | None = None)

content

The content within this box.

height

Make another attribute optional, e.g. allow None.

max_height

Make another attribute optional, e.g. allow None.

max_width

Make another attribute optional, e.g. allow None.

min_height

Make another attribute optional, e.g. allow None.

min_width

Make another attribute optional, e.g. allow None.

width

Make another attribute optional, e.g. allow None.