ProgressBar#

The <ProgressBar> component allows you to render the progress and loading state of something.

Import#

import { ProgressBar } from 'bumbag';

Usage#

<ProgressBar value={75} />

Sizes#

The progress bar comes with three preset sizes: small, medium and large.

<ProgressBar value={20} size="small" />
<ProgressBar value={40} />
<ProgressBar value={60} size="medium" />
<ProgressBar value={80} size="large" />

Colors#

You can use the color prop to add color to your progress bar.

<ProgressBar value={20} color="secondary" />
<ProgressBar value={40} color="success" />

Max value#

By default, the max value of a progress bar is 100. But you can customize this with the maxValue prop.

<ProgressBar value={100} maxValue={150} />

Animation#

function Example() {
  const [value, setValue] = React.useState(30);

  return (
    <Stack>
      <Set>
        <Button
          onClick={() => setValue(value => value - 10)}
        >
          -10
        </Button>
        <Button
          onClick={() => setValue(value => value + 10)}
        >
          +10
        </Button>
      </Set>
      <ProgressBar value={value} />
    </Stack>
  );
}

Accessibility#

Patterns#

• ProgressBar has a role of progressbar
• ProgressBar has the aria-valuenow attribute set to the current value of the progress bar.
• ProgressBar has the aria-valuemin attribute set to the minimum value of the progress bar.
• ProgressBar has the aria-valuemax attribute set to the maximum value of the progress bar.

References#

• Using the progressbar role

Props#

ProgressBar Props#

color string

Sets the color of the progress bar.

maxValue number

Sets the max value of the progress bar.

size

"default"
  | (string & {})
  | "small"
  | "medium"
  | "large"

Sets the size of the progress bar.

value number

Sets the value of the progress bar.

string
  | (ComponentClass<any, any> & { useProps: any; })
  | (FunctionComponent<any> & { useProps: any; })

string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)

{
  useCSSVariables?: boolean;
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  ... 95 more ...;
  Template?: TemplateThemeConfig;
}

Theming#

import { ThemeProvider } from 'bumbag';
const theme = {
  ProgressBar: {
    styles: {
      base: {
        background: "#ffe3a4"
      }
    }
  }
}
<ThemeProvider theme={theme}>...</ThemeProvider>

import { ThemeProvider } from 'bumbag';
const theme = {
  ProgressBar: {
    Indicator: {
      styles: {
        base: {
          background: "#ffe3a4"
        }
      }
    }
  }
}
<ThemeProvider theme={theme}>...</ThemeProvider>