読み込みバー コンポーネントの作成

<progress> 要素を使用して、色が適応し、ユーザー補助に対応した読み込みバーを作成する方法の概要。

この記事では、<progress> 要素を使用して、色が適応し、ユーザー補助に対応した読み込みバーを作成する方法について説明します。デモを試すソースを表示する

ライトモードとダークモード、未確定、増加、完了の各状態が Chrome でデモされています。

動画で確認したい場合は、YouTube 版の投稿をご覧ください。

概要

<progress> 要素は、完了に関する視覚的および音声によるフィードバックをユーザーに提供します。この視覚的なフィードバックは、フォームの進行状況、ダウンロードまたはアップロード情報の表示、進行状況が不明であるが処理がまだアクティブであることを示す場合などに役立ちます。

この GUI チャレンジでは、既存の HTML <progress> 要素を使用して、ユーザー補助の作業を軽減しました。色とレイアウトは、組み込み要素のカスタマイズの限界を押し広げ、コンポーネントをモダナイズしてデザイン システムに適合させます。

各ブラウザの明るいタブと暗いタブで、Safari、Firefox、Chrome の順に、アダプティブ アイコンの概要を確認できます。
Firefox、Safari、iOS Safari、Chrome、Android Chrome で、明るいスキームと暗いスキームの両方でデモが表示されます。

マークアップ

<progress> 要素を <label> でラップして、明示的な関係属性をスキップし、暗黙的な関係を優先しました。また、読み込み状態の影響を受ける親要素にラベルを付け、画面読み上げ技術がその情報をユーザーに伝えられるようにしました。

<progress></progress>

value がない場合、要素の進行状況は不明確です。max 属性のデフォルトは 1 であるため、進行状況は 0 ~ 1 の範囲になります。たとえば、max を 100 に設定すると、範囲は 0 ~ 100 に設定されます。0 ~ 1 の範囲内に収め、進行状況の値を 0.5 または 50% に変換することにしました。

ラベルでラップされた進行状況

暗黙的な関係では、進行状況要素は次のようにラベルで囲まれます。

<label>Loading progress<progress></progress></label>

デモでは、スクリーン リーダーのみにラベルを含めることにしました。ラベルテキストを <span> でラップし、スタイルを適用して、効果的に画面外にします。

<label>
  <span class="sr-only">Loading progress</span>
  <progress></progress>
</label>

WebAIM の次の CSS を使用します。

.sr-only {
  clip: rect(1px, 1px, 1px, 1px);
  clip-path: inset(50%);
  height: 1px;
  width: 1px;
  margin: -1px;
  overflow: hidden;
  padding: 0;
  position: absolute;
}

画面の読み取り専用要素を表示したデベロッパー ツールのスクリーンショット。

読み込みの進行状況によって影響を受ける領域

視力が良好なユーザーであれば、進行状況インジケーターを関連する要素やページ領域に簡単に関連付けることができますが、視覚障がいのあるユーザーにとっては、そうはいかないでしょう。これを改善するには、読み込みが完了したときに変更される最上位の要素に aria-busy 属性を割り当てます。さらに、aria-describedby を使用して、進行状況と読み込みゾーンの関係を示します。

<main id="loading-zone" aria-busy="true">
  …
  <progress aria-describedby="loading-zone"></progress>
</main>

JavaScript から、タスクの開始時に aria-busytrue に切り替え、完了したら false に切り替えます。

ARIA 属性の追加

<progress> 要素の暗黙的なロールは progressbar ですが、その暗黙的なロールがないブラウザ用に明示的に設定しました。また、indeterminate 属性を追加して、要素を不明の状態に明示的に設定しました。これは、要素に value が設定されていないことを確認するよりも明確です。

<label>
  Loading 
  <progress 
    indeterminate 
    role="progressbar" 
    aria-describedby="loading-zone"
    tabindex="-1"
  >unknown</progress>
</label>

tabindex="-1" を使用して、JavaScript から進行状況要素にフォーカスを当てられるようにします。これはスクリーン リーダー テクノロジーにとって重要です。進捗状況が変化するにつれて進捗状況にフォーカスを当てることで、更新された進捗状況がどの程度進んでいるかをユーザーに通知できます。

スタイル

スタイル設定に関しては、progress 要素は少し複雑です。組み込みの HTML 要素には、選択しにくい特殊な非表示部分があり、設定できるプロパティが限定されていることがよくあります。

レイアウト

レイアウト スタイルは、進行状況要素のサイズとラベルの位置を柔軟に設定できるようにすることを目的としています。特別な完了状態が追加されます。これは、追加の視覚的な手がかりとして役立ちますが、必須ではありません。

<progress> レイアウト

進行状況要素の幅は変更されていないため、デザインに必要なスペースに合わせて縮小または拡大できます。appearancebordernone に設定することで、組み込みスタイルが削除されます。これは、各ブラウザに要素固有のスタイルがあるため、ブラウザ間で要素を正規化できるようにするためです。

progress {
  --_track-size: min(10px, 1ex);
  --_radius: 1e3px;

  /*  reset  */
  appearance: none;
  border: none;

  position: relative;
  height: var(--_track-size);
  border-radius: var(--_radius);
  overflow: hidden;
}

_radius1e3px の値は、大きな数を表現するために科学的記数法を使用しているため、border-radius は常に丸められます。これは 1000px と同じです。設定して忘れられるほど十分に大きい値を使用することを目的としているため、この値を使用しています(また、1000px よりも短く記述できます)。必要に応じて、さらに大きくすることも簡単です。3 を 4 に変更するだけで、1e4px10000px と同等になります。

overflow: hidden は使用されていますが、議論の的となっています。これにより、border-radius 値をトラックやトラック フィリング要素に渡す必要がなくなるなど、いくつかのことが容易になりました。ただし、進行状況の子が要素の外部に存在することはできなくなりました。このカスタム プログレス要素を overflow: hidden なしでもう一度反復処理すると、アニメーションや完了状態を改善できる可能性があります。

処理が完了しました

CSS セレクタは、最大値と値を比較して、一致した場合は進行状況が完了します。完了すると、疑似要素が生成され、進行状況要素の末尾に追加されます。これにより、完了を視覚的に示す追加のキューが提供されます。

progress:not([max])[value="1"]::before,
progress[max="100"][value="100"]::before {
  content: "✓";
  
  position: absolute;
  inset-block: 0;
  inset-inline: auto 0;
  display: flex;
  align-items: center;
  padding-inline-end: max(calc(var(--_track-size) / 4), 3px);

  color: white;
  font-size: calc(var(--_track-size) / 1.25);
}

読み込みバーが 100% に達し、最後にチェックマークが表示されているスクリーンショット。

ブラウザには、進行状況要素に独自の色が用意されており、1 つの CSS プロパティで明るい色と暗い色に適応します。これは、ブラウザ固有の特別なセレクタを使用して構築できます。

明るいブラウザ スタイルと暗いブラウザ スタイル

サイトをダークモードとライトモードに適応する <progress> 要素にするには、color-scheme のみが必要です。

progress {
  color-scheme: light dark;
}

単一プロパティの進行状況の塗りつぶし色

<progress> 要素を色付けするには、accent-color を使用します。

progress {
  accent-color: rebeccapurple;
}

トラックの背景色は、accent-color に応じて明るい色から暗い色に変化します。ブラウザが適切なコントラストを保証しています。

明るい色と暗い色を完全にカスタマイズ

<progress> 要素に 2 つのカスタム プロパティを設定します。1 つはトラック色用、もう 1 つはトラックの進行状況の色用です。prefers-color-scheme メディアクエリ内で、トラックとトラックの進行状況の新しい色値を指定します。

progress {
  --_track: hsl(228 100% 90%);
  --_progress: hsl(228 100% 50%);
}

@media (prefers-color-scheme: dark) {
  progress {
    --_track: hsl(228 20% 30%);
    --_progress: hsl(228 100% 75%);
  }
}

フォーカス スタイル

先ほど、要素に負のタブ インデックスを設定したので、プログラムでフォーカスを設定できるようになりました。:focus-visible を使用してフォーカスをカスタマイズし、よりスマートなフォーカスリング スタイルを有効にします。これにより、マウスクリックとフォーカスではフォーカス リングは表示されませんが、キーボードのクリックでは表示されます。詳しくは、YouTube 動画をご覧ください。

progress:focus-visible {
  outline-color: var(--_progress);
  outline-offset: 5px;
}

読み込みバーのスクリーンショット(周囲にフォーカスリングがある)。色がすべて一致している。

ブラウザ間のカスタム スタイル

各ブラウザが公開する <progress> 要素の部分を選択して、スタイルをカスタマイズします。progress 要素は単一のタグですが、CSS 擬似セレクタで公開されるいくつかの子要素で構成されています。この設定を有効にすると、Chrome DevTools に次の要素が表示されます。

  1. ページを右クリックし、[要素を検証] を選択して DevTools を開きます。
  2. DevTools ウィンドウの右上にある設定アイコン(歯車)をクリックします。
  3. [要素] の見出しで、[ユーザー エージェントのシャドウ DOM を表示] チェックボックスを見つけてオンにします。

DevTools でユーザー エージェントの Shadow DOM の公開を有効にする場所のスクリーンショット。

Safari と Chromium のスタイル

Safari や Chromium などの WebKit ベースのブラウザは、::-webkit-progress-bar::-webkit-progress-value を公開し、CSS のサブセットを使用できるようにします。現時点では、前述のカスタム プロパティを使用して background-color を設定し、明るい色と暗い色に適応させます。

/*  Safari/Chromium  */
progress[value]::-webkit-progress-bar {
  background-color: var(--_track);
}

progress[value]::-webkit-progress-value {
  background-color: var(--_progress);
}

進行状況要素の内部要素を示すスクリーンショット。

Firefox のスタイル

Firefox では、<progress> 要素にのみ ::-moz-progress-bar 疑似セレクタが公開されます。つまり、トラックを直接色付けすることはできません。

/*  Firefox  */
progress[value]::-moz-progress-bar {
  background-color: var(--_progress);
}

Firefox のスクリーンショットと、進行状況要素の部分の場所。

Safari、iOS Safari、Firefox、Chrome、Chrome for Android のすべてで読み込みバーが動作しているデバッグコーナーのスクリーンショット。

Firefox ではトラック色が accent-color から設定されているのに対し、iOS Safari ではトラックが明るい青色になっています。ダークモードでも同じです。Firefox にはダーク トラックがありますが、設定したカスタム色はありません。これは、WebKit ベースのブラウザで機能します。

アニメーション

ブラウザに組み込まれている疑似セレクタを使用する場合、許可される CSS プロパティは限定的です。

トラックの充電アニメーション

進行状況要素の inline-size に遷移を追加すると、Chromium では動作しますが、Safari では動作しません。Firefox では、::-moz-progress-bar に遷移プロパティも使用しません。

/*  Chromium Only 😢  */
progress[value]::-webkit-progress-value {
  background-color: var(--_progress);
  transition: inline-size .25s ease-out;
}

:indeterminate 状態をアニメーション化する

ここでは、アニメーションを表示できるように、もう少し工夫します。Chromium の疑似要素が作成され、3 つのブラウザすべてで前後にアニメーション化されるグラデーションが適用されます。

カスタム プロパティ

カスタム プロパティは多くの用途に適していますが、私が特に気に入っているのは、魔法のように見える CSS 値に名前を付けることです。以下は、かなり複雑な linear-gradient ですが、わかりやすい名前になっています。目的とユースケースが明確に理解できる。

progress {
  --_indeterminate-track: linear-gradient(to right,
    var(--_track) 45%,
    var(--_progress) 0%,
    var(--_progress) 55%,
    var(--_track) 0%
  );
  --_indeterminate-track-size: 225% 100%;
  --_indeterminate-track-animation: progress-loading 2s infinite ease;
}

カスタム プロパティを使用すると、これらのブラウザ固有のセレクタをグループ化できないため、コードを DRY に保つこともできます。

キーフレーム

目標は、前後に動く無限のアニメーションです。開始キーフレームと終了キーフレームは CSS で設定します。開始位置に戻るアニメーションを作成するには、50% の中間キーフレーム 1 つだけが必要です。

@keyframes progress-loading {
  50% {
    background-position: left; 
  }
}

各ブラウザをターゲットとする

すべてのブラウザで、<progress> 要素自体に疑似要素を作成したり、進行状況バーをアニメーション化したりすることはできません。擬似要素よりもトラックのアニメーションをサポートしているブラウザが多いため、ベースとして擬似要素からアニメーション バーにアップグレードしました。

Chromium 疑似要素

Chromium では、要素を覆う位置を指定して疑似要素 ::after を使用できます。未確定のカスタム プロパティが使用され、前後に動くアニメーションが非常にうまく機能します。

progress:indeterminate::after {
  content: "";
  inset: 0;
  position: absolute;
  background: var(--_indeterminate-track);
  background-size: var(--_indeterminate-track-size);
  background-position: right; 
  animation: var(--_indeterminate-track-animation);
}
Safari の進行状況バー

Safari では、カスタム プロパティとアニメーションが疑似要素の進行状況バーに適用されます。

progress:indeterminate::-webkit-progress-bar {
  background: var(--_indeterminate-track);
  background-size: var(--_indeterminate-track-size);
  background-position: right; 
  animation: var(--_indeterminate-track-animation);
}
Firefox の進行状況バー

Firefox では、カスタム プロパティとアニメーションが疑似要素の進行状況バーにも適用されます。

progress:indeterminate::-moz-progress-bar {
  background: var(--_indeterminate-track);
  background-size: var(--_indeterminate-track-size);
  background-position: right; 
  animation: var(--_indeterminate-track-animation);
}

JavaScript

JavaScript は <progress> 要素で重要な役割を果たします。要素に送信される値を制御し、スクリーン リーダーが使用できる十分な情報がドキュメントに存在するようにします。

const state = {
  val: null
}

このデモには、進行状況を制御するためのボタンがあります。これらのボタンは state.val を更新し、関数を呼び出して DOM を更新します。

document.querySelector('#complete').addEventListener('click', e => {
  state.val = 1
  setProgress()
})

setProgress()

この関数で UI/UX のオケストレーションが行われます。まず、setProgress() 関数を作成します。state オブジェクト、進行状況要素、<main> ゾーンにアクセスできるため、パラメータは必要ありません。

const setProgress = () => {
  
}

<main> ゾーンの読み込みステータスの設定

進行状況が完了しているかどうかに応じて、関連する <main> 要素の aria-busy 属性を更新する必要があります。

const setProgress = () => {
  zone.setAttribute('aria-busy', state.val < 1)
}

充電量が不明な場合は属性を消去

値が不明または未設定(この使用例では null)の場合は、value 属性と aria-valuenow 属性を削除します。これにより、<progress> が未確定になります。

const setProgress = () => {
  zone.setAttribute('aria-busy', state.val < 1)

  if (state.val === null) {
    progress.removeAttribute('aria-valuenow')
    progress.removeAttribute('value')
    progress.focus()
    return
  }
}

JavaScript の 10 進数演算の問題を修正

進行状況のデフォルトの最大値を 1 に維持するため、デモの増分関数と減分関数では小数点数演算を使用しています。JavaScript などの言語は、必ずしもその点で優れているとは限りません。以下は、数学演算の結果から余分な部分を切り捨てる roundDecimals() 関数です。

const roundDecimals = (val, places) =>
  +(Math.round(val + "e+" + places)  + "e-" + places)

値を丸めて、表示可能で読みやすいようにします。

const setProgress = () => {
  zone.setAttribute('aria-busy', state.val < 1)

  if (state.val === null) {
    progress.removeAttribute('aria-valuenow')
    progress.removeAttribute('value')
    progress.focus()
    return
  }

  const val = roundDecimals(state.val, 2)
  const valPercent = val * 100 + "%"
}

スクリーン リーダーとブラウザの状態の値を設定する

この値は、DOM の次の 3 つの場所で使用されます。

  1. <progress> 要素の value 属性。
  2. aria-valuenow 属性。
  3. <progress> の内部テキスト コンテンツ。
const setProgress = () => {
  zone.setAttribute('aria-busy', state.val < 1)

  if (state.val === null) {
    progress.removeAttribute('aria-valuenow')
    progress.removeAttribute('value')
    progress.focus()
    return
  }

  const val = roundDecimals(state.val, 2)
  const valPercent = val * 100 + "%"

  progress.value = val
  progress.setAttribute('aria-valuenow', valPercent)
  progress.innerText = valPercent
}

進行状況にフォーカスを当てる

値が更新されると、視覚に障がいのあるユーザーには進行状況の変化が表示されますが、スクリーン リーダー ユーザーには変更の通知はまだ表示されません。<progress> 要素にフォーカスすると、ブラウザが更新を通知します。

const setProgress = () => {
  zone.setAttribute('aria-busy', state.val < 1)

  if (state.val === null) {
    progress.removeAttribute('aria-valuenow')
    progress.removeAttribute('value')
    progress.focus()
    return
  }

  const val = roundDecimals(state.val, 2)
  const valPercent = val * 100 + "%"

  progress.value = val
  progress.setAttribute('aria-valuenow', valPercent)
  progress.innerText = valPercent

  progress.focus()
}

読み込みバーの進行状況をユーザーに読み上げる Mac OS VoiceOver アプリのスクリーンショット。

まとめ

私の方法をご覧になったところで、あなたならどうしますか?

もう一度チャンスがあれば、いくつか変更したい点はありますが、現在のコンポーネントをクリーンアップする余地があり、<progress> 要素の疑似クラス スタイルの制限なしでコンポーネントを構築する余地があると思います。ぜひお試しください。

アプローチを多様化し、ウェブで構築するすべての方法を学びましょう。

デモを作成して、ツイートしてください。リンクを送信していただければ、下のコミュニティ リミックスのセクションに追加します。

コミュニティ リミックス