UI: ProgressBar
A labelled progress bar with its value as text. Import the token file once (@pithyx/ui/tokens.css) and wrap the app in UiProvider; see @pithyx/ui.
Generated from the TSDoc comments of @pithyx/ui 1.0.0-rc.9 at build time; the text below the headings is the comment in the source.
Interfaces
Section titled “Interfaces”ProgressBarProps
Section titled “ProgressBarProps”The props of ProgressBar: React Aria’s progress bar props plus the label.
Extends
Section titled “Extends”Omit<AriaProgressBarProps,"className"|"children">
Properties
Section titled “Properties”label: ReactNode;The label above the bar, also the accessible name.
showValue?
Section titled “showValue?”optional showValue?: boolean;Whether the value is shown as text next to the label; true when left out.
className?
Section titled “className?”optional className?: string;Extra class names, added after the bar’s own.
Functions
Section titled “Functions”ProgressBar()
Section titled “ProgressBar()”function ProgressBar(props): Element;A labelled progress bar that shows its value as text unless showValue is false. Without value it is
indeterminate only when isIndeterminate is set.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
props |
ProgressBarProps |
React Aria’s progress bar props (value, minValue, maxValue, formatOptions) plus the label. |
Returns
Section titled “Returns”Element
The progress bar with its label.