Progress
タスクの進行状況(確定または不確定)です。
プログレスバー用のWAI-ARIA APGパターンはありません。Progressはprogressbarロールを持つ<div>を描画します。ディスク使用量など、範囲内で上下する値にはMeterを使用してください。
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>
);
});.progress-default {
display: grid;
grid-template-columns: 1fr auto;
row-gap: 8px;
align-items: center;
width: 240px;
font-family: inherit;
}
.progress-default-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.progress-default-value {
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
text-align: right;
}
.progress-default-track {
grid-column: 1 / -1;
height: 8px;
border-radius: 9999px;
background: light-dark(#e2e8f0, #ffffff1f);
overflow: hidden;
}
.progress-default-indicator {
height: 100%;
/* Percentage of the Root value, set by the library */
width: var(--leve-progress-percent);
border-radius: 9999px;
background: #009dfd;
transition: width 200ms ease;
}
@media (prefers-reduced-motion: reduce) {
.progress-default-indicator {
transition: none;
}
}インストール#
個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。
pnpm add @leve-ui/progressnpm install @leve-ui/progressyarn add @leve-ui/progressbun add @leve-ui/progresspnpm add @leve-ui/corenpm install @leve-ui/coreyarn add @leve-ui/corebun add @leve-ui/core構造#
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"になります。
import { component$, useSignal, useStyles$ } from '@builder.io/qwik';
import { Progress } from '@leve-ui/progress';
import styles from './controlled.css?inline';
export default component$(() => {
useStyles$(styles);
const value = useSignal(0);
return (
<div class="progress-controlled-wrapper">
<Progress.Root value={value.value} class="progress-controlled">
<Progress.Label class="progress-controlled-label">Uploading</Progress.Label>
<Progress.ValueText class="progress-controlled-value" />
<Progress.Track class="progress-controlled-track">
<Progress.Indicator class="progress-controlled-indicator" />
</Progress.Track>
</Progress.Root>
<div class="progress-controlled-buttons">
<button
type="button"
class="progress-controlled-button"
onClick$={() => (value.value = Math.min(value.value + 25, 100))}
>
Advance
</button>
<button type="button" class="progress-controlled-button" onClick$={() => (value.value = 0)}>
Reset
</button>
</div>
</div>
);
});.progress-controlled {
display: grid;
grid-template-columns: 1fr auto;
row-gap: 8px;
align-items: center;
width: 240px;
font-family: inherit;
}
.progress-controlled-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.progress-controlled-value {
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
text-align: right;
}
.progress-controlled-track {
grid-column: 1 / -1;
height: 8px;
border-radius: 9999px;
background: light-dark(#e2e8f0, #ffffff1f);
overflow: hidden;
}
.progress-controlled-indicator {
height: 100%;
/* Percentage of the Root value, set by the library */
width: var(--leve-progress-percent);
border-radius: 9999px;
background: #009dfd;
transition: width 200ms ease;
}
@media (prefers-reduced-motion: reduce) {
.progress-controlled-indicator {
transition: none;
}
}
.progress-controlled-wrapper {
display: flex;
flex-direction: column;
gap: 12px;
font-family: inherit;
}
.progress-controlled-buttons {
display: flex;
gap: 8px;
}
.progress-controlled-button {
height: 32px;
padding: 0 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 13px;
font-weight: 500;
cursor: pointer;
}
.progress-controlled-button:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
.progress-controlled-button:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}Indeterminate#
value={null}(デフォルト)は進行状況が不明であることを意味します。状態は"indeterminate"になり、CSSは[data-state="indeterminate"]でIndicatorをアニメーション化します。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Progress } from '@leve-ui/progress';
import styles from './indeterminate.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Progress.Root value={null} class="progress-indeterminate">
<Progress.Label class="progress-indeterminate-label">Uploading</Progress.Label>
<Progress.ValueText class="progress-indeterminate-value" />
<Progress.Track class="progress-indeterminate-track">
<Progress.Indicator class="progress-indeterminate-indicator" />
</Progress.Track>
</Progress.Root>
);
});.progress-indeterminate {
display: grid;
grid-template-columns: 1fr auto;
row-gap: 8px;
align-items: center;
width: 240px;
font-family: inherit;
}
.progress-indeterminate-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.progress-indeterminate-value {
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
text-align: right;
}
.progress-indeterminate-track {
grid-column: 1 / -1;
height: 8px;
border-radius: 9999px;
background: light-dark(#e2e8f0, #ffffff1f);
overflow: hidden;
}
.progress-indeterminate-indicator {
height: 100%;
/* Percentage of the Root value, set by the library */
width: var(--leve-progress-percent);
border-radius: 9999px;
background: #009dfd;
transition: width 200ms ease;
}
/* No percentage while indeterminate, so slide a fixed-width bar instead */
.progress-indeterminate-indicator[data-state="indeterminate"] {
width: 40%;
animation: progress-indeterminate-slide 1.2s ease-in-out infinite;
}
@keyframes progress-indeterminate-slide {
from {
transform: translateX(-100%);
}
to {
transform: translateX(250%);
}
}
@media (prefers-reduced-motion: reduce) {
.progress-indeterminate-indicator[data-state="indeterminate"] {
animation: none;
}
}値テキスト付き#
valueTextはパーセンテージを人間が読めるテキストに置き換えます。Progress.ValueTextによって表示され、aria-valuetextとして使用されます。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Progress } from '@leve-ui/progress';
import styles from './with-value-text.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Progress.Root value={30} valueText="3 of 10 files" class="progress-with-value-text">
<Progress.Label class="progress-with-value-text-label">Uploading</Progress.Label>
<Progress.ValueText class="progress-with-value-text-value" />
<Progress.Track class="progress-with-value-text-track">
<Progress.Indicator class="progress-with-value-text-indicator" />
</Progress.Track>
</Progress.Root>
);
});.progress-with-value-text {
display: grid;
grid-template-columns: 1fr auto;
row-gap: 8px;
align-items: center;
width: 240px;
font-family: inherit;
}
.progress-with-value-text-label {
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.progress-with-value-text-value {
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
text-align: right;
}
.progress-with-value-text-track {
grid-column: 1 / -1;
height: 8px;
border-radius: 9999px;
background: light-dark(#e2e8f0, #ffffff1f);
overflow: hidden;
}
.progress-with-value-text-indicator {
height: 100%;
/* Percentage of the Root value, set by the library */
width: var(--leve-progress-percent);
border-radius: 9999px;
background: #009dfd;
transition: width 200ms ease;
}
@media (prefers-reduced-motion: reduce) {
.progress-with-value-text-indicator {
transition: none;
}
}APIリファレンス#
Root#
| Prop | デフォルト | 型 |
|---|---|---|
| value | null | number | null 現在の値。 |
| min | 0 | number 最小値。 |
| max | 100 | number 最大値。 |
| valueText | – | string 値の人間が読めるテキスト(例: |
すべての<div>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-progress | 常に存在 |
data-state | "indeterminate" | "loading" | "complete" |
data-value | minとmaxの間に固定された値。不確定時は存在しません |
data-min | minの値 |
data-max | maxの値 |
data-stateは、valueがnullのときは"indeterminate"、値がmaxに達したときは"complete"、それ以外の場合は"loading"になります。
Label#
独自のpropはありません。 すべての<span>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-progress-label | 常に存在 |
data-state | "indeterminate" | "loading" | "complete" |
data-value | 固定された値。不確定時は存在しません |
data-min | minの値 |
data-max | maxの値 |
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-min | minの値 |
data-max | maxの値 |
RootのvalueTextを描画し、設定されていない場合は四捨五入されたパーセンテージ(例:"40%")を描画します。不確定時かつvalueTextが設定されていない場合は空になります。子要素は持ちません。
Track#
独自のpropはありません。 すべての<div>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-progress-track | 常に存在 |
data-state | "indeterminate" | "loading" | "complete" |
data-value | 固定された値。不確定時は存在しません |
data-min | minの値 |
data-max | maxの値 |
Indicator#
独自のpropはありません。 すべての<div>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-progress-indicator | 常に存在 |
data-state | "indeterminate" | "loading" | "complete" |
data-value | 固定された値。不確定時は存在しません |
data-min | minの値 |
data-max | maxの値 |
| 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にはキーボード操作はありません。