Socket
Socket
Sign inDemoInstall

@rmwc/circular-progress

Package Overview
Dependencies
19
Maintainers
1
Versions
143
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @rmwc/circular-progress

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.


Version published
Maintainers
1
Install size
1.46 MB
Created

Readme

Source

Circular Progress

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 @rmwc/circular-progress
  • Import styles:
    • Using CSS Loader
      • import '@rmwc/circular-progress/styles';
    • Or include stylesheets
      • '@rmwc/circular-progress/circular-progress.css'

Basic Usage

<CircularProgress label="progress" />
<>
  <CircularProgress label="progress" progress={0.3} />
  <CircularProgress label="progress" progress={0.6} />
  <CircularProgress label="progress" progress={0.9} />
  <CircularProgress label="progress" progress={1} />
</>

Sizing

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

Usage with other components

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

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

  <ChipSet>
    <Chip
      icon={<CircularProgress label="progress" size="xsmall" />}
      label="Donuts"
    />
  </ChipSet>
</>

CircularProgress

A Circular Progress indicator.

Props

NameTypeDescription
closedbooleanHides the progress bar. Adding / removing this prop will trigger an animation in or out.
labelstringThe label which will set an aria-label.
maxnumberMax value for determinate progress bars.
minnumberMin value for determinate progress bars.
progressnumberValue for determinate progress bars.
sizenumber | SizeThe size of the loader you would like to render.

Keywords

FAQs

Last updated on 24 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc