react-toolbox/components/progress_bar
Panjie Setiawan Wicaksono f365724ee8 Restructure typescript definitions (#1114)
* ts: restructure typescript definitions

- Add each raw components  types
- Update layout props to the new layout implementation
- Add table definitions
- Add HOC types

* fix ListItem typescript definition

* add themr identifiers definitions

* simplify React.ReactNode properties

* React.ReactNode | string => React.ReactNode is already indirectly type aliased to string
2017-01-18 08:37:37 +01:00
..
__test__ Migrate styles to PostCSS (#666) 2017-01-05 02:42:18 +01:00
ProgressBar.d.ts Restructure typescript definitions (#1114) 2017-01-18 08:37:37 +01:00
ProgressBar.js Implement disabled state for Slider and Progressi Bar 2016-10-19 14:20:07 +02:00
config.css Migrate styles to PostCSS (#666) 2017-01-05 02:42:18 +01:00
index.d.ts Restructure typescript definitions (#1114) 2017-01-18 08:37:37 +01:00
index.js Migrate styles to PostCSS (#666) 2017-01-05 02:42:18 +01:00
readme.md Update Google URLs 2016-11-06 21:18:36 +02:00
theme.css Migrate styles to PostCSS (#666) 2017-01-05 02:42:18 +01:00

readme.md

Progress Bar

Minimize visual changes that occur while your app loads content by representing each operation with a single activity indicator. For example, a refresh operation should display either a refresh bar or an activity circle, but not both.

import ProgressBar from 'react-toolbox/lib/progress_bar';

const ProgressTest = () => (
  <div>
    <ProgressBar type="circular" mode="indeterminate" />
    <ProgressBar type="linear" mode="determinate" value={83} buffer={90} />
  </div>
);

If you want to provide a theme via context, the component key is RTProgressBar.

Properties

Name Type Default Description
buffer Number 0 Value of a secondary progress bar useful for buffering.
className String '' Additional class name to provide custom styling.
disabled Boolean false If true, component will be disabled.
max Number 100 Maximum value permitted.
min Number 0 Minimum value permitted.
mode String indeterminate Mode of the progress bar, it can be determinate or indeterminate.
multicolor Boolean false If true, the circular progress bar will be changing its color.
type String linear Type of the progress bar, it can be circular or linear.
value Number 0 Value of the current progress.

Theme

Name Description
buffer Used to style the buffer element in the linear progress.
circle Used for the circle element in the circular progress.
circular Used for the root element when the type is circular.
indeterminate Added to the root element if mode is indeterminate.
linear Used for the root element when the type is linear.
multicolor Added to the root if the component is multicolor (circular).
path Used for the inner path in the circular progress.
value Used to style the value element in the linear progress.