プログレス

Progress

スタックバー、アニメーション背景、テキストラベルをサポートするBootstrapカスタムプログレスバーを使用するためのドキュメントとサンプルです。

項目

v5.3.0の新しいマークアップ — 以前のプログレスバーのHTML構造を廃止し、より利用しやすいものに置き換えました。以前の構造はv6まで機能し続けます。マイグレーションガイドの変更点をご覧ください

基礎知識

プログレスコンポーネントは、2つのHTML要素、幅を設定するためのCSS、およびいくつかの属性で構築されています。HTML5の<progress>要素を使用しないため、プログレスバーを積み重ねてアニメーション化できます、その上にテキストラベルを配置します。

プログレスバーの最大値を示すラッパーとして.progressを使用します。
また、.progressラッパーにはrole="progress"とaria属性が必要で、アクセス可能な名前（aria-label,aria-labelledbyなどの属性を使用）を指定する必要があります。
内部の.progress-barは純粋に視覚的なバーとラベルのために使用します。 -.progress-barの幅を設定するには、インラインスタイル、ユーティリティクラス、またはカスタムCSSが必要です。
複数のプログレスバーを作成するために、特別な.progress-stackedクラスを提供します。

これらすべてを組み合わせると、次の例のようになります。

html

<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar" style="width: 0%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar" style="width: 25%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar" style="width: 50%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar" style="width: 75%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar" style="width: 100%"></div>
</div>

バーのサイズ調整

幅

Bootstrapは、一握りの幅を設定するためのユーティリティを提供します。あなたのニーズに応じて、これらは.progress-barの幅を素早く設定するのに役立つかもしれません。

html

<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar w-75"></div>
</div>

高さ

heightの値は.progressコンテナにしか設定されていないので、その値を変更すれば、内部の.progress-barもそれに合わせて自動的にサイズ変更されます。

html

<div class="progress" role="progressbar" aria-label="Example 1px high" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100" style="height: 1px">
  <div class="progress-bar" style="width: 25%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Example 20px high" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100" style="height: 20px">
  <div class="progress-bar" style="width: 25%"></div>
</div>

ラベル

.progress-bar内にテキストを配置して、プログレスバーにラベルを追加します。

25%

html

<div class="progress" role="progressbar" aria-label="Example with label" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar" style="width: 25%">25%</div>
</div>

デフォルトでは、.progress-bar内のコンテンツはoverflow: hiddenで制御され、バーからはみ出ないようになっています。プログレスバーの長さがラベルの長さより短い場合、コンテンツは制限され、読めなくなる可能性があります。この動作を変更するには、オーバーフローユーティリティから.overflow-visibleを使用することができますが、テキストが読みやすくなるように、明示的にテキストカラーも定義してください。しかし、現在のところ、この方法はカラーモードを考慮していないことに注意してください。

Long label text for the progress bar, set to a dark color

html

<div class="progress" role="progressbar" aria-label="Example with label" aria-valuenow="10" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar overflow-visible text-dark" style="width: 10%">Long label text for the progress bar, set to a dark color</div>
</div>

背景

バックグラウンドユーティリティクラスを使用して、個々のプログレスバーの外観を変更します。

html

<div class="progress" role="progressbar" aria-label="Success example" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-success" style="width: 25%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Info example" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-info" style="width: 50%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Warning example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-warning" style="width: 75%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Danger example" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-danger" style="width: 100%"></div>
</div>

支援技術に意味を伝える

色を使用して意味を付加することは、視覚的な表示を提供するだけであり、スクリーンリーダーなどの支援技術の利用者には伝わりません。色で示される情報は、コンテンツ自体（例：可視テキスト）から明らかですが、.visually-hiddenクラスで隠された追加テキストなど、別の手段で含まれていることを確認してください。

カスタム背景色のプログレスバーにラベルを追加する場合、適切なテキストカラーも設定して、ラベルが読みやすく、十分なコントラストが保たれるようにしてください。

25%

50%

75%

100%

html

<div class="progress" role="progressbar" aria-label="Success example" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-success" style="width: 25%">25%</div>
</div>
<div class="progress" role="progressbar" aria-label="Info example" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-info text-dark" style="width: 50%">50%</div>
</div>
<div class="progress" role="progressbar" aria-label="Warning example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-warning text-dark" style="width: 75%">75%</div>
</div>
<div class="progress" role="progressbar" aria-label="Danger example" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar bg-danger" style="width: 100%">100%</div>
</div>

あるいは、新しい色と背景ヘルパークラスを組み合わせて使うこともできます。

75%

html

<div class="progress" role="progressbar" aria-label="Warning example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar text-bg-warning" style="width: 75%">75%</div>
</div>

複数のバー

コンテナ内に複数のプログレスコンポーネントを.progress-stackedで含めると、1つのスタック型プログレスバーを作成することができます。この場合、プログレスバーの視覚的な幅を設定するスタイリングは.progress-bar要素ではなく、.progress要素に適用する必要があることに注意してください。

html

<div class="progress-stacked">
  <div class="progress" role="progressbar" aria-label="Segment one" aria-valuenow="15" aria-valuemin="0" aria-valuemax="100" style="width: 15%">
    <div class="progress-bar"></div>
  </div>
  <div class="progress" role="progressbar" aria-label="Segment two" aria-valuenow="30" aria-valuemin="0" aria-valuemax="100" style="width: 30%">
    <div class="progress-bar bg-success"></div>
  </div>
  <div class="progress" role="progressbar" aria-label="Segment three" aria-valuenow="20" aria-valuemin="0" aria-valuemax="100" style="width: 20%">
    <div class="progress-bar bg-info"></div>
  </div>
</div>

ストライプ

プログレスバーの背景色の上にCSSグラデーションでストライプを適用するには、任意の.progress-barに.progress-bar-stripedを追加します。

html

<div class="progress" role="progressbar" aria-label="Default striped example" aria-valuenow="10" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar progress-bar-striped" style="width: 10%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Success striped example" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar progress-bar-striped bg-success" style="width: 25%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Info striped example" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar progress-bar-striped bg-info" style="width: 50%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Warning striped example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar progress-bar-striped bg-warning" style="width: 75%"></div>
</div>
<div class="progress" role="progressbar" aria-label="Danger striped example" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar progress-bar-striped bg-danger" style="width: 100%"></div>
</div>

ストライプのアニメーション

縞模様のグラデーションもアニメーション化できます。CSS3アニメーションでストライプを右から左にアニメーション化するには、.progress-bar-animatedを.progress-barに追加します。

html

<div class="progress" role="progressbar" aria-label="Animated striped example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100">
  <div class="progress-bar progress-bar-striped progress-bar-animated" style="width: 75%"></div>
</div>

CSS

変数

Added in v5.2.0

Bootstrapの進化するCSS変数アプローチの一部として、プログレス・バーは、リアルタイムのカスタマイズを強化するために、.progressのローカルCSS変数を使用するようになりました。CSS変数の値はSass経由で設定されるため、Sassによるカスタマイズも引き続きサポートされます。

scss/_progress.scss

--#{$prefix}progress-height: #{$progress-height};
@include rfs($progress-font-size, --#{$prefix}progress-font-size);
--#{$prefix}progress-bg: #{$progress-bg};
--#{$prefix}progress-border-radius: #{$progress-border-radius};
--#{$prefix}progress-box-shadow: #{$progress-box-shadow};
--#{$prefix}progress-bar-color: #{$progress-bar-color};
--#{$prefix}progress-bar-bg: #{$progress-bar-bg};
--#{$prefix}progress-bar-transition: #{$progress-bar-transition};

Sass変数

scss/_variables.scss

$progress-height:                   1rem;
$progress-font-size:                $font-size-base * .75;
$progress-bg:                       var(--#{$prefix}secondary-bg);
$progress-border-radius:            var(--#{$prefix}border-radius);
$progress-box-shadow:               var(--#{$prefix}box-shadow-inset);
$progress-bar-color:                $white;
$progress-bar-bg:                   $primary;
$progress-bar-animation-timing:     1s linear infinite;
$progress-bar-transition:           width .6s ease;

キーフレーム

.progress-bar-animatedのCSSアニメーションを作成するために使用します。scss/_progress-bar.scssに含まれています。

scss/_progress.scss

@if $enable-transitions {
  @keyframes progress-bar-stripes {
    0% { background-position-x: $progress-height; }
  }
}