Progress

Show how far a known task has advanced. Use a determinate value when progress can be measured; use a spinner when it cannot.

Examples

Sizes

JSX usage

Install this example’s dependencies, load the package stylesheet from Setup, and add Example CSS where shown. The snippet includes its local helpers.

bun add @kongmy-dev/sapphire-ui react react-dom radix-ui

"use client";
import { Progress } from "@kongmy-dev/sapphire-ui/progress";

function ProgressSizes() {
  return (
    <div className="sp-stack">
      <Progress value={30} size="sm" aria-label="Small progress" />
      <Progress value={60} aria-label="Default progress" />
      <Progress value={90} size="lg" aria-label="Large progress" />
    </div>
  );
}

export default ProgressSizes;

Example CSS

Load these demo styles alongside the package stylesheet for the same layout and surfaces.

.docs-progress-stack {
  max-width: calc(var(--space-1) * 100);
}

.docs-progress-bars {
  gap: var(--space-6);
  width: 100%;
  max-width: calc(var(--space-1) * 100);
}

.docs-progress-meta {
  display: flex;
  justify-content: space-between;
  margin-bottom: var(--space-2);
  font-size: var(--text-xs);
  line-height: calc(var(--space-1) * 4);
}

.docs-progress-name {
  font-weight: 500;
  color: var(--foreground-strong);
}

.docs-progress-percent {
  font-family: var(--font-mono);
  font-weight: 500;
  color: var(--foreground-strong);
}

HTML markup

Initial rendered HTML only. React handlers and portalled content require the JSX example; static HTML does not reproduce those interactions.

Values

JSX usage

Install this example’s dependencies, load the package stylesheet from Setup, and add Example CSS where shown. The snippet includes its local helpers.

bun add @kongmy-dev/sapphire-ui react react-dom radix-ui

"use client";
import { Progress } from "@kongmy-dev/sapphire-ui/progress";

function ProgressValues() {
  return (
    <div className="sp-stack">
      <Progress value={25} aria-label="Upload progress" showLabel />
      <Progress value={100} aria-label="Completed upload" showLabel />
      <Progress value={null} aria-label="Preparing upload" showLabel />
    </div>
  );
}

export default ProgressValues;

Example CSS

Load these demo styles alongside the package stylesheet for the same layout and surfaces.

.docs-progress-stack {
  max-width: calc(var(--space-1) * 100);
}

.docs-progress-bars {
  gap: var(--space-6);
  width: 100%;
  max-width: calc(var(--space-1) * 100);
}

.docs-progress-meta {
  display: flex;
  justify-content: space-between;
  margin-bottom: var(--space-2);
  font-size: var(--text-xs);
  line-height: calc(var(--space-1) * 4);
}

.docs-progress-name {
  font-weight: 500;
  color: var(--foreground-strong);
}

.docs-progress-percent {
  font-family: var(--font-mono);
  font-weight: 500;
  color: var(--foreground-strong);
}

HTML markup

Initial rendered HTML only. React handlers and portalled content require the JSX example; static HTML does not reproduce those interactions.

Props

Generated from the current public TypeScript signatures, including composed behaviour props. “—” means no default is declared in the local signature; forwarded behaviour defaults are not inferred.

Progress component props
Prop	Type	Required	Local default
`value`	`number \| null \| undefined`	No	`0`
`max`	`number \| undefined`	No	`100`
`getValueLabel`	`((value: number, max: number) => string) \| undefined`	No	—
`asChild`	`boolean \| undefined`	No	—
`showLabel`	`boolean \| undefined`	No	—
`size`	`"sm" \| "lg" \| "default" \| undefined`	No	`'default'`
`indicatorClassName`	`string \| undefined`	No	—

Inherited HTML / React props (280)

Progress common platform props
Prop	Type	Required	Local default
`style`	`CSSProperties \| undefined`	No	—
`defaultValue`	`string \| number \| readonly string[] \| undefined`	No	—
`className`	`string \| undefined`	No	—
`id`	`string \| undefined`	No	—
`tabIndex`	`number \| undefined`	No	—
`role`	`import("react").AriaRole \| undefined`	No	—
`aria-label`	`string \| undefined`	No	—
`children`	`import("react").ReactNode`	No	—
`onChange`	`import("react").ChangeEventHandler<HTMLDivElement, Element> \| undefined`	No	—
`ref`	`import("react").Ref<HTMLDivElement> \| undefined`	No	—

All inherited prop names:

slot style title key defaultChecked defaultValue suppressContentEditableWarning suppressHydrationWarning accessKey autoCapitalize autoFocus className contentEditable contextMenu dir draggable enterKeyHint hidden id lang nonce spellCheck tabIndex translate radioGroup role about content datatype inlist prefix property rel resource rev typeof vocab autoCorrect autoSave color itemProp itemScope itemType itemID itemRef results security unselectable popover popoverTargetAction popoverTarget inert inputMode is exportparts part aria-activedescendant aria-atomic aria-autocomplete aria-braillelabel aria-brailleroledescription aria-busy aria-checked aria-colcount aria-colindex aria-colindextext aria-colspan aria-controls aria-current aria-describedby aria-description aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowindextext aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext children dangerouslySetInnerHTML onCopy onCopyCapture onCut onCutCapture onPaste onPasteCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onFocus onFocusCapture onBlur onBlurCapture onChange onChangeCapture onBeforeInput onBeforeInputCapture onInput onInputCapture onReset onResetCapture onSubmit onSubmitCapture onInvalid onInvalidCapture onLoad onLoadCapture onError onErrorCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onAbort onAbortCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLoadStart onLoadStartCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onProgress onProgressCapture onRateChange onRateChangeCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onStalled onStalledCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onAuxClick onAuxClickCapture onClick onClickCapture onContextMenu onContextMenuCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onSelect onSelectCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onPointerDown onPointerDownCapture onPointerMove onPointerMoveCapture onPointerUp onPointerUpCapture onPointerCancel onPointerCancelCapture onPointerEnter onPointerLeave onPointerOver onPointerOverCapture onPointerOut onPointerOutCapture onGotPointerCapture onGotPointerCaptureCapture onLostPointerCapture onLostPointerCaptureCapture onScroll onScrollCapture onScrollEnd onScrollEndCapture onWheel onWheelCapture onAnimationStart onAnimationStartCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onToggle onBeforeToggle onTransitionCancel onTransitionCancelCapture onTransitionEnd onTransitionEndCapture onTransitionRun onTransitionRunCapture onTransitionStart onTransitionStartCapture ref

ARIA attributes and native event handlers keep their React types. data-* attributes are also accepted by React.

Setup

bun add @kongmy-dev/sapphire-ui react react-dom radix-ui

For an app using package components throughout, load the full stylesheet once. Add this component import where you use it.

import "@kongmy-dev/sapphire-ui/sapphire.css";
import { Progress } from "@kongmy-dev/sapphire-ui/progress";

Mixing package and vendored components? Follow application setup.