dbcProgress: Progress component

In dash: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications

Progress component

Description

A component for creating progress bars just with CSS. Control the current progress with a callback and the 'value' prop.

Usage

dbcProgress(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, bar=NULL, min=NULL, max=NULL,
value=NULL, label=NULL, hide_label=NULL, animated=NULL,
striped=NULL, color=NULL, loading_state=NULL)

Arguments

children	A list of or a singular dash component, string or number. The children of this component. Use this to nest progress bars.
id	Character. The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.
style	Named list. Defines CSS styles which will override styles previously set.
class_name	Character. Often used with CSS to style elements with common properties.
className	Character. **DEPRECATED** Use 'class_name' instead. Often used with CSS to style elements with common properties.
key	Character. A unique identifier for the component, used to improve performance by React.js while rendering components See https://reactjs.org/docs/lists-and-keys.html for more info
bar	Logical. Set to True when nesting Progress inside another Progress component to create a multi-progress bar.
min	Numeric. Upper limit for value, default: 100
max	Numeric. Upper limit for value, default: 100
value	Character | numeric. Specify progress, value from min to max inclusive.
label	Character. Adds a label to the progress bar.
hide_label	Logical. Set to True to hide the label.
animated	Logical. Animate the bar, must have striped set to True to work.
striped	Logical. Use striped progress bar
color	Character. Set color of the progress bar, options: primary, secondary, success, warning, danger, info or any valid CSS color of your choice (e.g. a hex code, a decimal code or a CSS color name).
loading_state	Lists containing elements 'is_loading', 'prop_name', 'component_name'. those elements have the following types: - is_loading (logical; optional): determines if the component is loading or not - prop_name (character; optional): holds which property is loading - component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer

Value

named list of JSON elements corresponding to React.js properties and their values

dash documentation built on June 23, 2022, 9:11 a.m.