`duck.html.components.progressbar`¶

Progress bar component.

Module Contents¶

Classes¶

ProgressBar

Modern loading bar with JavaScript and Python update helpers.

Data¶

PROGRESS_BAR_SCRIPT

API¶

duck.html.components.progressbar.PROGRESS_BAR_SCRIPT = <Multiline-String>¶

class duck.html.components.progressbar.ProgressBar(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

Modern loading bar with JavaScript and Python update helpers.

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.
**kwargs – Extra keyword arguments

Raises:

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

on_create() → None[source]¶: Initialize and compose the progress bar.

set_progress_color(color: str) → None[source]¶

Set the filled progress indicator color.

Parameters:: color – CSS color value.

set_track_color(color: str) → None[source]¶

Set the progress track/background color.

Parameters:: color – CSS color value.

update_progress(progress: int) → None[source]¶

Update the progress bar from Python.