ProgressBar

Server component, no client JS

ImportCopy Anchor Link

import { ProgressBar } from '@nizivo/react/progress-bar';

// Once per app (Getting started), after
// @nizivo/tokens/tokens.css and @nizivo/react/css/base.css
import '@nizivo/react/css/progress-bar.css';

Static or interactiveCopy Anchor Link

Server. It ships no client JavaScript when a Server Component renders it, in every Next.js build mode; its code is bundled only when a client component (a 'use client' file) imports it. The indeterminate bar is a CSS animation. How to choose.

In a client app (a Vite or React Router single-page app, or a 'use client' file) it is an ordinary React component: event handlers, refs and state work as usual. In a client app.

ExamplesCopy Anchor Link

import type { JSX } from 'react';
import { ProgressBar } from '@nizivo/react/progress-bar';

export function ProgressBarExample(): JSX.Element {
  return (
    <div>
      <ProgressBar label="Monthly goal" value={68} />
      <ProgressBar label="Setup guide" value={3} max={5} valueText="3 of 5 steps" tone="success" />
      <ProgressBar label="Uploading product photos" indeterminate />
      <ProgressBar aria-label="Import" value={40} showValue={false} tone="neutral" />
    </div>
  );
}

PropsCopy Anchor Link

Other exportsCopy Anchor Link

ProgressBarProps type

import type { ProgressBarProps } from '@nizivo/react/progress-bar'

The props of ProgressBar, listed above.

ProgressBarState type

import type { ProgressBarState } from '@nizivo/react/progress-bar'

The render state of ProgressBar, listed above.

ProgressBarTone type

import type { ProgressBarTone } from '@nizivo/react/progress-bar'

Figma "Tone" (Brand, Warning, Critical) plus success and neutral.

type ProgressBarTone = "brand" | "success" | "warning" | "critical" | "neutral"

Data attributes and slotsCopy Anchor Link

Style parts by class (.nz-<slot>) and state by data attribute. Attribute meanings come from contracts/vocabulary.json.

CSS hooksCopy Anchor Link

Set a hook on the component's class or any ancestor to restyle it without specificity games; leave it unset for the default shown.

Layers: nz.components. Classes: .nz-progress-bar, .nz-progress-bar-header, .nz-progress-bar-label, .nz-progress-bar-track, .nz-progress-bar-value.

AccessibilityCopy Anchor Link

Nothing in this component takes focus or keyboard input.

In forced-colours mode these states keep a visible system colour: progress-bar-track::-webkit-progress-value (fill), progress-bar-track::-moz-progress-bar (fill).

KeyboardCopy Anchor Link

None.

FigmaCopy Anchor Link

Node ids from design/component-map.json, which nz gen writes from component.json. The links open the Nizivo Figma library, which may ask you to sign in.

• Canonical: Figma node 7275:13526
• Ghost masters: Figma node 751:367