@pmwcs/circular-progress
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

Circular Progress (PMWCS Addon)

Circular progress indicators display progress by animating an indicator along an invisible circular track in a clockwise direction. They can be applied directly to a surface, such as a button or card.

  • Module @pmwcs/circular-progress
  • Import styles:
    • Using CSS Loader
      • import '@pmwcs/circular-progress/styles';
    • Or include stylesheets
      • '@pmwcs/circular-progress/circular-progress.css'

Basic Usage

<CircularProgress />
<>
  <CircularProgress progress={0.3} />
  <CircularProgress progress={0.6} />
  <CircularProgress progress={0.9} />
</>

Sizing

<>
  <CircularProgress size="xsmall" />
  <CircularProgress size="small" />
  <CircularProgress size="medium" />
  <CircularProgress size="large" />
  <CircularProgress size="xlarge" />
  <CircularProgress size={72} />
</>

Usage with other components

<>
  <Button
    icon={<CircularProgress theme="secondary" />}
    label="Cookies"
  />

  <List>
    <SimpleListItem graphic={<CircularProgress />} text="Pizza" />
    <SimpleListItem graphic="favorite" text="Icecream" />
  </List>

  <Chip icon={<CircularProgress />} label="Donuts" />
</>

CircularProgress

A Circular Progress indicator.

Props

Name Type Description
max undefined | number Max value for determinate progress bars.
min undefined | number Min value for determinate progress bars.
progress undefined | number Value for determinate progress bars.
size "xsmall" | "small" | "medium" | "large" | "xlarge" | number The size of the loader you would like to render.
secondary true | false | undefined Use secondary theme.
standard true | false | undefined Use standard theme.

Package Sidebar

Install

npm i @pmwcs/circular-progress

Weekly Downloads

1

Version

1.1.0

License

MIT

Unpacked Size

14.4 kB

Total Files

10

Last publish

Collaborators

  • commenthol