1.1.0 • Published 3 years ago

@pmwcs/circular-progress v1.1.0

Weekly downloads
5
License
MIT
Repository
github
Last release
3 years ago

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

NameTypeDescription
maxundefined \| numberMax value for determinate progress bars.
minundefined \| numberMin value for determinate progress bars.
progressundefined \| numberValue for determinate progress bars.
size"xsmall" \| "small" \| "medium" \| "large" \| "xlarge" \| numberThe size of the loader you would like to render.
secondarytrue \| false \| undefinedUse secondary theme.
standardtrue \| false \| undefinedUse standard theme.