quirl.components.divider

A horizontal or vertical section divider.

Module Contents

Classes

Divider

A horizontal or vertical section divider.

API

class quirl.components.divider.Divider(element: Optional[str] = None, properties: Optional[Dict[str, str]] = None, props: Optional[Dict[str, str]] = None, style: Optional[Dict[str, str]] = None, inner_html: Optional[Union[str, str, float]] = None, children: Optional[List[duck.html.components.HtmlComponent]] = None, **kwargs)[source]

Bases: duck.html.components.container.Container

A horizontal or vertical section divider.

Renders as a thin line, or as a line-label-line row when a label is given. Vertical dividers do not support labels.

Usage:

Divider(orientation="horizontal", label="OR")

Optional Props:

  • orientation: horizontal or vertical. Defaults to horizontal.

  • label: Optional centered text label (horizontal only).

  • color: Line color, defaults to var(–quirl-border-color)

Initialization

Initialize an HTML component.

Parameters:

  • element – The HTML element tag name (e.g., textarea, input, button). Can be None, but make sure element is returned by get_element method.

  • accept_inner_html – Whether the HTML component accepts an inner body (e.g., inner-body-here).

  • inner_html – Inner html to add to the HTML component. Defaults to None.

  • properties – Dictionary for properties to initialize the component with.

  • props – Just same as properties argument (added for simplicity).

  • style – Dictionary for style to initialize the component with.

  • event_handlers – Events to automatically bind. Each dictionary maps an event name to its handler and may include additional keyword arguments forwarded to bind(), e.g. event_handlers=[{"click": on_button_click, **extra_kwargs}].

  • **kwargs – Extra keyword arguments

Raises:

HtmlComponentError – If ‘element’ is not a string or ‘inner_html’ is set but ‘accept_inner_html’ is False.

build_line(color: str) → duck.html.components.container.Container[source]

Build a single flexible divider line segment.

Parameters:

color – Line color to use.

Returns:

A thin, flex-grow Container acting as the line.

docs_preview_kwargs

None

on_create()[source]

Build the divider with optional label and orientation.