ドキュメントを検索

Progress

タスクの進行状況(確定または不確定)です。

プログレスバー用のWAI-ARIA APGパターンはありません。Progressはprogressbarロールを持つ<div>を描画します。ディスク使用量など、範囲内で上下する値にはMeterを使用してください。

Uploading40%
import { component$, useStyles$ } from '@builder.io/qwik';
import { Progress } from '@leve-ui/progress';
import styles from './default.css?inline';

export default component$(() => {
  useStyles$(styles);

  return (
    <Progress.Root value={40} class="progress-default">
      <Progress.Label class="progress-default-label">Uploading</Progress.Label>
      <Progress.ValueText class="progress-default-value" />
      <Progress.Track class="progress-default-track">
        <Progress.Indicator class="progress-default-indicator" />
      </Progress.Track>
    </Progress.Root>
  );
});

インストール#

個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。

pnpm add @leve-ui/progress

構造#

import { Progress } from '@leve-ui/progress'; // or '@leve-ui/core'

<Progress.Root>
  <Progress.Label />
  <Progress.ValueText />
  <Progress.Track>
    <Progress.Indicator />
  </Progress.Track>
</Progress.Root>
パーツ要素説明
Progress.Root<div>role="progressbar"を持つプログレスバーです。値と範囲を保持します。
Progress.Label<span>ラベルです。Rootの名前を指定します。
Progress.ValueText<span>値のテキスト(デフォルトではパーセンテージ)を表示します。
Progress.Track<div>範囲全体です。Indicatorを含みます。
Progress.Indicator<div>現在の値です。パーセンテージをCSS変数として公開します。

例#

Controlled#

valueはシグナルに従います。値がmaxに達すると、状態は"complete"になります。

Uploading0%

Indeterminate#

value={null}(デフォルト)は進行状況が不明であることを意味します。状態は"indeterminate"になり、CSSは[data-state="indeterminate"]でIndicatorをアニメーション化します。

Uploading

値テキスト付き#

valueTextはパーセンテージを人間が読めるテキストに置き換えます。Progress.ValueTextによって表示され、aria-valuetextとして使用されます。

Uploading3 of 10 files

APIリファレンス#

Root#

Propデフォルト型
valuenullnumber | null

現在の値。nullは進捗が不確定であることを意味します。

min0number

最小値。

max100number

最大値。

valueText–string

値の人間が読めるテキスト(例:"3 / 10 files")。aria-valuetextに使用され、ValueTextによって表示されます。デフォルトはパーセンテージ(例:"30%")です。

すべての<div>属性も受け入れます。

データ属性値
data-leve-progress常に存在
data-state"indeterminate" | "loading" | "complete"
data-valueminとmaxの間に固定された値。不確定時は存在しません
data-minminの値
data-maxmaxの値

data-stateは、valueがnullのときは"indeterminate"、値がmaxに達したときは"complete"、それ以外の場合は"loading"になります。

Label#

独自のpropはありません。 すべての<span>属性を受け入れます。

データ属性値
data-leve-progress-label常に存在
data-state"indeterminate" | "loading" | "complete"
data-value固定された値。不確定時は存在しません
data-minminの値
data-maxmaxの値

Labelは生成されたidを取得し、Rootはそれをaria-labelledbyで参照します。独自のidを渡す場合は、Rootにも同じ値をaria-labelledbyとして渡してください。

ValueText#

独自のpropはありません。 すべての<span>属性を受け入れます。

データ属性値
data-leve-progress-value-text常に存在
data-state"indeterminate" | "loading" | "complete"
data-value固定された値。不確定時は存在しません
data-minminの値
data-maxmaxの値

RootのvalueTextを描画し、設定されていない場合は四捨五入されたパーセンテージ(例:"40%")を描画します。不確定時かつvalueTextが設定されていない場合は空になります。子要素は持ちません。

Track#

独自のpropはありません。 すべての<div>属性を受け入れます。

データ属性値
data-leve-progress-track常に存在
data-state"indeterminate" | "loading" | "complete"
data-value固定された値。不確定時は存在しません
data-minminの値
data-maxmaxの値

Indicator#

独自のpropはありません。 すべての<div>属性を受け入れます。

データ属性値
data-leve-progress-indicator常に存在
data-state"indeterminate" | "loading" | "complete"
data-value固定された値。不確定時は存在しません
data-minminの値
data-maxmaxの値
CSS変数値
--leve-progress-percent範囲のパーセンテージとしての値(例:40%)。不確定時は設定されません

ライブラリは幅を設定しません。width: var(--leve-progress-percent)のように、ご自身で変数を使用してください。

アクセシビリティ#

  • Progress.Rootはrole="progressbar"をaria-valueminとaria-valuemaxとともに描画し、不確定時を除いてaria-valuenowを、valueTextが設定されている場合はaria-valuetextを描画します。
  • Rootはaria-labelledbyを通じてProgress.Labelによって名前付けされます。Rootにaria-labelまたはaria-labelledbyを渡した場合は、代わりにそれが使用されます。
  • パーセンテージだけでは進行状況を説明できない場合(例:「10ファイル中3ファイル」)、valueTextを設定してください。
  • Progressにはキーボード操作はありません。