Webパーツ辞典

トグルボタンToggle button

押すたびに「入」と「切」が入れ替わるボタン。お気に入りやミュートのように、押したあとも状態が残る操作に使う。

表示例

アイコン: Font Awesome 7 Free(fa-solid / fa-regular)

別名・英語表記

  • オンオフボタン
  • 押し込みボタン
  • 状態ボタン
  • いいねボタン
  • ハートボタン
  • お気に入りボタン
  • Toggle button

実装例

<button class="x-toggle-button" type="button" aria-pressed="true">
  <i class="fa-solid fa-bookmark" aria-hidden="true"></i>
  保存する
</button>

AIへの指示文

「トグルボタン(Toggle button)」を実装してください。

## これは何か
押すたびに「入」と「切」が入れ替わるボタン。お気に入りやミュートのように、押したあとも状態が残る操作に使う。

## 使いどころ
- お気に入り・ミュート・ブックマークなど、対象のすぐそばで切り替えたいとき
- 設定画面を開かせずに、その場で状態を変えさせたいとき

## 実装の要件
- button 要素 + aria-pressed。押したとき属性とアイコンを同時に更新する
- 普通のボタンと見分けが付かないと、押した結果が状態なのか処理なのか分からない
- 入と切でラベルを入れ替えると、いまどちらなのか読み取れなくなる。ラベルは固定し、状態だけを変える
- 見た目が変わるだけで手応えが無いと、二度押しされる

## アクセシビリティの要件
- aria-pressed="true|false" を付ける。見た目だけで状態を示さない
- 状態の変化は aria-pressed で伝わる。別のアナウンスを重ねすぎない
- 色を反転させるだけでなく、アイコンの形も変える

## 参考にする実装
この形を出発点にして、プロジェクトの命名規則・色・余白に合わせて調整してください。

```html
<button class="x-toggle-button" type="button" aria-pressed="true">
  <i class="fa-solid fa-bookmark" aria-hidden="true"></i>
  保存する
</button>
```

```css
/* 貼った先のリセットに頼らないよう、この部品の中だけ border-box にする */
.x-toggle-button,
.x-toggle-button *:not([class*="fa-"]),
.x-toggle-button *:not([class*="fa-"])::before,
.x-toggle-button *:not([class*="fa-"])::after {
  box-sizing: border-box;
  /* 貼った先の既定の書体に引きずられないようにする。書体が変わると
     文字の幅と高さが変わり、枠のサイズまでずれる */
  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Hiragino Sans", "Noto Sans JP", "Yu Gothic UI", Meiryo, sans-serif;
}

.x-toggle-button {
  display: inline-flex;
  align-items: center;
  gap: 8px;
  min-height: 40px;
  padding: 0 16px;
  border: 1px solid #cfd4dc;
  border-radius: 8px;
  background: #fff;
  color: #1b2028;
  font: inherit;
  font-size: 14px;
  cursor: pointer;
}
.x-toggle-button[aria-pressed="true"] {
  border-color: #1d4ed8;
  background: #eef2ff;
  color: #1d4ed8;
  font-weight: 700;
}
.x-toggle-button:focus-visible {
  outline: 2px solid #1d4ed8;
  outline-offset: 2px;
}
```

## 出力の約束
- HTML と CSS を分けて出す。JavaScript が要るときは素の JavaScript で書き、UIフレームワークは使わない。
- 参考実装がアイコンに Font Awesome のクラスを使っている場合は、プロジェクトで使っているアイコンかインライン SVG に置き換えてよい。
- 上のアクセシビリティ要件を満たす。満たせない箇所があるときは、理由を添えて先に知らせる。
- 色・角丸・余白は既存のデザイントークンがあればそれを使う。無ければ CSS 変数として切り出す。

使いどころ

  • お気に入り・ミュート・ブックマークなど、対象のすぐそばで切り替えたいとき
  • 設定画面を開かせずに、その場で状態を変えさせたいとき

注意点

  • 普通のボタンと見分けが付かないと、押した結果が状態なのか処理なのか分からない
  • 入と切でラベルを入れ替えると、いまどちらなのか読み取れなくなる。ラベルは固定し、状態だけを変える
  • 見た目が変わるだけで手応えが無いと、二度押しされる

アクセシビリティの要点

  • aria-pressed="true|false" を付ける。見た目だけで状態を示さない
  • 状態の変化は aria-pressed で伝わる。別のアナウンスを重ねすぎない
  • 色を反転させるだけでなく、アイコンの形も変える

見分け方

関連するパーツ