ProgressRing

Server component, no client JS

ImportCopy Anchor Link

import { ProgressRing } from '@nizivo/react/progress-ring';

// Once per app (Getting started), after
// @nizivo/tokens/tokens.css and @nizivo/react/css/base.css
import '@nizivo/react/css/progress-ring.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. 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 { ProgressRing } from '@nizivo/react/progress-ring';

export function ProgressRingExample(): JSX.Element {
  return (
    <div>
      <ProgressRing aria-label="Store setup" value={25} />
      <ProgressRing aria-label="Monthly goal" meter value={75} tone="success" size="lg" />
      <ProgressRing aria-label="Products imported" value={3} max={4} valueText="3 of 4" size="sm">
        3/4
      </ProgressRing>
    </div>
  );
}

PropsCopy Anchor Link

Other exportsCopy Anchor Link

ProgressRingProps type

import type { ProgressRingProps } from '@nizivo/react/progress-ring'

The props of ProgressRing, listed above.

ProgressRingSize type

import type { ProgressRingSize } from '@nizivo/react/progress-ring'

48 / 72 / 96 px; Figma draws only 72.

type ProgressRingSize = "sm" | "md" | "lg"

ProgressRingState type

import type { ProgressRingState } from '@nizivo/react/progress-ring'

The render state of ProgressRing, listed above.

ProgressRingTone type

import type { ProgressRingTone } from '@nizivo/react/progress-ring'

type ProgressRingTone = "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-ring, .nz-progress-ring-fill, .nz-progress-ring-label, .nz-progress-ring-svg, .nz-progress-ring-track.

AccessibilityCopy Anchor Link

Nothing in this component takes focus or keyboard input.

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:13545
• Ghost masters: Figma node 751:388