@blueprintjs/core
Version:
Core styles & components
31 lines (19 loc) • 1.21 kB
Markdown
@# Progress bars
Progress bars can indicate determinate progress towards the completion of a task or an indeterminate
loading state.
@## CSS API
Set the current progress of the bar via a `width` style rule on the inner `.pt-progress-meter`
element. This is a very simple CSS-only component, and input validation for `width` values is
limited: values above `100%` appear as 100% progress and values below `0%` appear as 0%.
Omitting `width` will result in an "indeterminate" progress meter that fills the entire bar.
@css pt-progress-bar
@## JavaScript API
The `ProgressBar` component is available in the __@blueprintjs/core__ package.
Make sure to review the [general usage docs for JS components](#blueprint.usage).
A `ProgressBar` is a simple stateless component that renders the appropriate HTML markup.
It supports a `value` prop between 0 and 1 that determines the width of the progress meter.
Omitting `value` will result in an "indeterminate" progress meter that fills the entire bar.
Note that the CSS modifiers described in the [CSS API](#core/components/progress/progress-bar.css-api)
are supported via the `className` prop.
@interface IProgressBarProps
@reactExample ProgressExample