Components

Progress

Indeterminate

Astro

---
import { Progress } from "@opui/astro"
---

<Progress aria-busy="true" />

Output

<progress aria-busy="true" class="progress"></progress>

Determinate

Astro

---
import { Progress } from "@opui/astro"
---

<Progress id="determinate-progress" max="100" value="10" />

<script>
  const progress = document.querySelector(
    "#determinate-progress",
  ) as HTMLProgressElement
  if (progress) {
    setInterval(() => {
      if (progress.value >= 100) {
        progress.value = 10
      } else {
        progress.value += 10
      }
    }, 3000)
  }
</script>

Output

<script type="module">
  const e = document.querySelector("#determinate-progress");
  e &&
    setInterval(() => {
      e.value >= 100 ? (e.value = 10) : (e.value += 10);
    }, 3e3);
</script>
<progress
  class="progress"
  id="determinate-progress"
  max="100"
  value="10"
></progress>

Variants

Use the variant prop to swap the progress bar track surface for better contrast on different backgrounds.

Astro

---
import { Progress } from "@opui/astro"
---

<Progress value="25" max="100" variant="default" />
<Progress value="50" max="100" variant="filled" />
<Progress value="75" max="100" variant="tonal" />

Output

<progress class="progress default" max="100" value="25"></progress>
<progress class="progress filled" max="100" value="50"></progress>
<progress class="progress tonal" max="100" value="75"></progress>

Accessibility

If the <progress> element is describing the loading progress of a section of a page:

use aria-describedby to point to the status
set aria-busy="true" on the section that is being updated, removing it when loading is finished.

Source: MDN

Content here is loading.

API

Prop	Type	Default	Description
`value`	`number \| string`	-	The current value of the progress bar.
`max`	`number \| string`	-	The maximum value of the progress bar.
`aria-busy`	`"true" \| "false" \| boolean`	-	Indicates that the element or its content is being modified.
`aria-label`	`string`	-	Accessible label for the progress bar.
`variant`	`'filled' \| 'default' \| 'tonal'`	`'default'`	Adjusts the progress bar background color for better contrast on different surfaces.

Installation

progress.css

@layer components.root {
  :where(progress) {
    --_accent-color: var(--primary);
    --_bg-color: var(--surface-tonal);

    appearance: none;
    background-color: var(--_bg-color);
    block-size: var(--size-1);
    border: 0;
    border-radius: var(--border-radius, 0.25rem);
    display: inline-block;
    inline-size: 100%;
    overflow: hidden;
    position: relative;
    vertical-align: baseline;

    /* Color */
    &.filled {
      --_bg-color: var(--surface-filled);
    }

    &.default {
      --_bg-color: var(--surface-default);
    }

    &.tonal {
      --_bg-color: var(--surface-tonal);
    }

    &::-webkit-progress-bar {
      background: none;
      border-radius: var(--border-radius, 0.25rem);
    }

    &[value]::-webkit-progress-value {
      background-color: var(--_accent-color);

      @media (prefers-reduced-motion: no-preference) {
        transition: inline-size 0.2s var(--ease-out-4, cubic-bezier(0, 0, 0.1, 1));
      }
    }

    &::-moz-progress-bar {
      background-color: var(--_accent-color);
    }
  }

  @media (prefers-reduced-motion: no-preference) {
    progress:indeterminate {
      background-color: var(--_bg-color);

      &::after {
        animation: indeterminate 2s linear infinite;
        background-color: var(--_accent-color);
        content: "";
        inset: 0 auto 0 0;
        position: absolute;
        will-change: inset-inline-start, inset-inline-end;
      }

      &[value]::-webkit-progress-value {
        background-color: transparent;
      }

      &::-moz-progress-bar {
        background-color: transparent;
      }
    }

    [dir="rtl"] {
      :where(progress):indeterminate {
        animation-direction: reverse;

        &::after {
          animation-direction: reverse;
        }
      }
    }
  }

  @keyframes indeterminate {
    0% {
      inset-inline-start: -200%;
      inset-inline-end: 100%;
    }

    60% {
      inset-inline-start: 107%;
      inset-inline-end: -8%;
    }

    100% {
      inset-inline-start: 107%;
      inset-inline-end: -8%;
    }
  }
}