quirl.components.badge

A compact status indicator badge.

Module Contents

Classes

Badge

A compact status indicator badge.

Data

SIZE_STYLE_MAP

VARIANT_TOKEN_MAP

API

class quirl.components.badge.Badge(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.span.Span

A compact status indicator badge.

Renders as a tinted rounded pill, ideal for statuses, counts, or categories. Pulls colors from the active theme by default.

Usage:

Badge(text="New", variant="success")

Required Props:

  • text: The badge label text

Optional Props:

  • variant: One of neutral, accent, success, warning, error, info. Defaults to neutral.

  • dot: Render as a small solid dot with no text. Defaults to False.

  • size: One of sm, md, lg. Defaults to md.

  • bg_color: Override background color.

  • color: Override text 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.

docs_preview_kwargs

None

on_create()[source]

Build the badge with theme-aware tinting, sizing, and radius.

quirl.components.badge.SIZE_STYLE_MAP

None

quirl.components.badge.VARIANT_TOKEN_MAP

None