Skip to content

Progress

Displays a value indicating completion of a task.

Progress renders role="progressbar" with determinate or indeterminate state. It supports horizontal and vertical orientations.

Anatomy

  • #indicator: Filled portion of the track.

Usage

Upload progress65%
Indeterminate

Examples

Custom indicator

Use #indicator to render your own fill element using the exposed percentage.

vue
@layer akaza-reset;
@import "tailwindcss";
@import "akaza-ui/dist/akaza-ui.css";

Indeterminate state

Set the model value to null to indicate an unknown duration.

vue
<template>
  <Avatar
    src="/avatar.jpg"
    alt="Jane Doe"
    text="JD"
    :delay-ms="300"
  />
</template>

Custom range

Use min and max when progress is measured on a scale other than 0 to 100.

vue
<Button
  :ui="{
    root: 'rounded-md bg-black px-3 py-2 text-white',
    spinner: 'size-4 animate-spin',
  }"
>
  Save
</Button>

Custom value label

Use get-value-label to provide a clearer screen reader value.

vue
<template>
  <Button
    as="a"
    href="/docs"
  >
    Read the docs
  </Button>
</template>

Vertical orientation

Use vertical orientation when progress should match a vertical layout.

vue
<template>
  <Button
    disabled
    focusable-when-disabled
  >
    Restricted
  </Button>
</template>

Value Bounds

Finite values are clamped to the effective bounds for ARIA, slots, percentage, and completion state without rewriting the model. A null or non-finite value is indeterminate. A non-finite minimum falls back to 0; an invalid maximum falls back to the effective minimum plus 100.

API Reference

Props

PropTypeDefaultDescription
modelValuenumber | nullnullCurrent progress value. null = indeterminate.
minnumber0Minimum value.
maxnumber100Maximum value.
orientation"horizontal" | "vertical""horizontal"Orientation of the progress bar.
ariaLabelstring—Accessible label when no visible label is present.
getValueLabel(value: number | null, max: number) => string—Custom function to generate the aria-valuetext.
uiProgressUi—CSS class overrides.

Slots

SlotScoped propsDescription
indicator{ value, percentage, max, min, state }The filled indicator element. state is "indeterminate" when value is null.

UI Options

KeyDescription
rootThe outer track element.
indicatorThe fill indicator element.

Styling Hooks

UI keyCSS classData attrs
rootakaza-progressdata-akaza-state, data-akaza-orientation
indicatorakaza-progress-indicatordata-akaza-state

When value is determinate, root also sets --akaza-progress-percentage to a clamped percentage.

Edit this page on GitHub ↗