ボタン

Buttons

ボタンはフォームやダイアログなどのアクションにカスタムボタンスタイルを利用できます。サイズや状態管理に対応しています。ボタンの使い方の例を示します。

項目

基本のクラス

Bootstrapには、パディングやコンテンツの配置などの基本的なスタイルを設定するベースとなる.btnクラスがあります。デフォルトでは、.btnコントロールは透明なボーダーと背景色を持ち、明示的なフォーカススタイルとホバースタイルはありません。

html

<button type="button" class="btn">Base class</button>

.btnクラスは、ボタンバリエーションと組み合わせて使用したり、独自のカスタムスタイルのベースとして使用することを目的としています。

If you are using the .btn class on its own, remember to at least define some explicit :focus and/or :focus-visible styles.

バリエーション

Bootstrapにはいくつかのボタンバリエーションがあり、各ボタンはそれぞれの意味的な役割を果たし、さらにコントロールのためにいくつかの追加要素があります。

html

<button type="button" class="btn btn-primary">Primary</button>
<button type="button" class="btn btn-secondary">Secondary</button>
<button type="button" class="btn btn-success">Success</button>
<button type="button" class="btn btn-danger">Danger</button>
<button type="button" class="btn btn-warning">Warning</button>
<button type="button" class="btn btn-info">Info</button>
<button type="button" class="btn btn-light">Light</button>
<button type="button" class="btn btn-dark">Dark</button>

<button type="button" class="btn btn-link">Link</button>

支援技術に意味を伝える

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

テキスト折り返しの無効化

ボタンのテキストを折り返したくない場合は、.text-nowrapクラスをボタンに追加することができます。Sassでは、$btn-white-space: nowrapを設定することで、各ボタンのテキストの折り返しを無効にすることができます。

ボタンタグ

.btnクラスは<button>要素で使用するために設計されていますが、これらのクラスは<a>や<input>要素でも使うことができます。(ブラウザによっては若干異なるレンダリングが適用される場合があります)

現在のページ内で、新しいページやセクションへのリンクではなく、ページ内の機能(コンテンツの折りたたみなど)のトリガーとして使用される<a>要素に、ボタンクラスを使用する場合、これらのリンクにはrole="button"を与え、スクリーンリーダのような支援技術のためにその目的を適切に伝えるべきです。

Link

html

<a class="btn btn-primary" href="#" role="button">Link</a>
<button class="btn btn-primary" type="submit">Button</button>
<input class="btn btn-primary" type="button" value="Input">
<input class="btn btn-primary" type="submit" value="Submit">
<input class="btn btn-primary" type="reset" value="Reset">

アウトラインボタン

ボタンが必要だけど、背景色が多くて困る？デフォルトのモディファイアクラスを.btn-outline-*に置き換えることで、ボタンの背景画像や色をすべて取り除くことができます。

html

<button type="button" class="btn btn-outline-primary">Primary</button>
<button type="button" class="btn btn-outline-secondary">Secondary</button>
<button type="button" class="btn btn-outline-success">Success</button>
<button type="button" class="btn btn-outline-danger">Danger</button>
<button type="button" class="btn btn-outline-warning">Warning</button>
<button type="button" class="btn btn-outline-info">Info</button>
<button type="button" class="btn btn-outline-light">Light</button>
<button type="button" class="btn btn-outline-dark">Dark</button>

ボタンスタイルの中には比較的明るい色を使うものがあり、十分なコントラストを持たせるために暗い背景でのみ使用する必要があります。

サイズ

ボタンのサイズを.btn-lgや.btn-smを適用すると変更できます。

html

<button type="button" class="btn btn-primary btn-lg">Large button</button>
<button type="button" class="btn btn-secondary btn-lg">Large button</button>

html

<button type="button" class="btn btn-primary btn-sm">Small button</button>
<button type="button" class="btn btn-secondary btn-sm">Small button</button>

CSS変数で独自のサイズにすることもできます：

html

<button type="button" class="btn btn-primary"
        style="--bs-btn-padding-y: .25rem; --bs-btn-padding-x: .5rem; --bs-btn-font-size: .75rem;">
  Custom button
</button>

非アクティブ状態

ボタンを非アクティブに見せるには、<button>要素にdisabledを追加します。無効化されたボタンにはpointer-events: noneが適用され、ホバーやアクティブな状態がトリガーされるのを防ぎます。

html

<button type="button" class="btn btn-primary" disabled>Primary button</button>
<button type="button" class="btn btn-secondary" disabled>Button</button>
<button type="button" class="btn btn-outline-primary" disabled>Primary button</button>
<button type="button" class="btn btn-outline-secondary" disabled>Button</button>

<a>要素に対してボタンを非アクティブにする場合は少し異なります。:

<a>はdisabled属性をサポートしていません。disabledクラスを利用する必要があります。
アンカーボタンを無効化したスタイルを含んでいます。ブラウザがその機能をサポートしているのであればカーソルは見えなくなります。
無効化するボタンにはaria-distabled=”true”属性をつけてください(スクリーンリーダー用)
<a>を使用した無効化ボタンには、href属性は含まれないようにする必要があります。

Primary link Link

html

<a class="btn btn-primary disabled" role="button" aria-disabled="true">Primary link</a>
<a class="btn btn-secondary disabled" role="button" aria-disabled="true">Link</a>

リンク機能の注意点

無効化されたリンクにhref属性を保持しなければならない場合があるため、.disabledクラスはpointer-events: noneを使用して<a>のリンク機能を無効化しようとします。なお、このCSSプロパティはHTMLではまだ標準化されていませんが、最近のブラウザはすべてサポートしています。さらに、pointer-events: noneをサポートしているブラウザでも、キーボード操作は影響を受けないので、目の見えるキーボードユーザーや支援が必要なユーザーは、これらのリンクを有効にすることができます。安全のために、aria-disabled="true"に加えて、これらのリンクにtabindex="-1"属性を含めてキーボードフォーカスを受けないようにし、カスタムJavaScriptを使ってこれらの機能を完全に無効にします。

Primary link Link

html

<a href="#" class="btn btn-primary disabled" tabindex="-1" role="button" aria-disabled="true">Primary link</a>
<a href="#" class="btn btn-secondary disabled" tabindex="-1" role="button" aria-disabled="true">Link</a>

ブロックボタン

displayユーティリティとgapユーティリティを組み合わせて、Bootstrap4のような全幅の「ブロックボタン」のレスポンシブスタックを作成します。ボタン固有のクラスの代わりにユーティリティを使用することで、間隔、配置、およびレスポンシブ動作を大幅に制御できます。

html

<div class="d-grid gap-2">
  <button class="btn btn-primary" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

レスポンシブのバリエーションです。ブラウザのサイズを変更して、確認してみてください。mdブレークポイントまで、.d-md-blockが.d-gridクラスを置き換え、gap-2ユーティリティを無効にします。

html

<div class="d-grid gap-2 d-md-block">
  <button class="btn btn-primary" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

grid columnを使用して、ブロックボタンの幅を調整できます。たとえば、半分の幅の"block button"の場合は、.col-6を使用します。.mx-autoも水平方向に中央揃えにします。

html

<div class="d-grid gap-2 col-6 mx-auto">
  <button class="btn btn-primary" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

追加のユーティリティを使用して、水平の場合のボタンの配置を調整できます。前のレスポンシブな例を取り上げ、ボタンにいくつかのflexユーティリティとmarginユーティリティを追加して、ボタンがスタックされなくなったときにボタンが右揃えになります。

html

<div class="d-grid gap-2 d-md-flex justify-content-md-end">
  <button class="btn btn-primary me-md-2" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

ボタンのプラグイン

ボタンのプラグインでは、シンプルなオン/オフのトグルボタンを作成することができます。

視覚的には、これらのトグルボタンはチェックボックスのトグルボタンと同じです。ただし、スクリーンリーダーでは伝達方法が異なります。チェックボックスの切り替えは、スクリーンリーダーによって「チェック済み」/「チェックなし」としてアナウンスされます（外観にもかかわらず、基本的にはチェックボックスのままであるため）。一方、これらのトグルボタンは「ボタン」/「ボタンが押された」としてアナウンスされます。これら2つのアプローチのどちらを選択するかは、作成するトグルのタイプと、チェックボックスまたは実際のボタンとしてアナウンスされたときにトグルがユーザーにとって意味があるかどうかによって異なります。

トグルの状態

data-bs-toggle="button"を追加して, ボタンのactive状態を切り替えます。事前に切り替える場合は,.activeクラスとaria-pressed="true"を追加して, スクリーンリーダーに適切に伝達されるようにする必要があります。

html

<button type="button" class="btn btn-primary" data-bs-toggle="button">Toggle button</button>
<button type="button" class="btn btn-primary active" data-bs-toggle="button" aria-pressed="true">Active toggle button</button>
<button type="button" class="btn btn-primary" disabled data-bs-toggle="button">Disabled toggle button</button>

Toggle link Active toggle link Disabled toggle link

html

<a href="#" class="btn btn-primary" role="button" data-bs-toggle="button">Toggle link</a>
<a href="#" class="btn btn-primary active" role="button" data-bs-toggle="button" aria-pressed="true">Active toggle link</a>
<a class="btn btn-primary disabled" aria-disabled="true" role="button" data-bs-toggle="button">Disabled toggle link</a>

Methods

ボタンのインスタンスは、例えばボタンのコンストラクタを使って作成することができます。

const bsButton = new bootstrap.Button('#myButton')

Method	Description
`dispose`	ボタン要素を破棄します。(DOM要素に保存されているデータを削除します)
`getInstance`	OM要素に関連付けられたボタンのインスタンスを取得できる静的メソッドで、次のように使用できます。：`bootstrap.Button.getInstance(要素)`
`getOrCreateInstance`	DOM要素に関連付けられたボタンのインスタンスを返すか、初期化されていない場合は新規に作成する静的メソッドです。次のように使うことができます：`bootstrap.Button.getOrCreateInstance(要素)`。
`toggle`	プッシュ状態を切り替えます。ボタンがアクティブになったように見せます。

例えば、すべてのボタンをトグルする例は下記です。

document.querySelectorAll('.btn').forEach(buttonElement => {
  const button = bootstrap.Button.getOrCreateInstance(buttonElement)
  button.toggle()
})

CSS

変数

Added in v5.2.0

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

scss/_buttons.scss

--#{$prefix}btn-padding-x: #{$btn-padding-x};
--#{$prefix}btn-padding-y: #{$btn-padding-y};
--#{$prefix}btn-font-family: #{$btn-font-family};
@include rfs($btn-font-size, --#{$prefix}btn-font-size);
--#{$prefix}btn-font-weight: #{$btn-font-weight};
--#{$prefix}btn-line-height: #{$btn-line-height};
--#{$prefix}btn-color: #{$btn-color};
--#{$prefix}btn-bg: transparent;
--#{$prefix}btn-border-width: #{$btn-border-width};
--#{$prefix}btn-border-color: transparent;
--#{$prefix}btn-border-radius: #{$btn-border-radius};
--#{$prefix}btn-hover-border-color: transparent;
--#{$prefix}btn-box-shadow: #{$btn-box-shadow};
--#{$prefix}btn-disabled-opacity: #{$btn-disabled-opacity};
--#{$prefix}btn-focus-box-shadow: 0 0 0 #{$btn-focus-width} rgba(var(--#{$prefix}btn-focus-shadow-rgb), .5);

それぞれの.btn-*修飾クラスは適切なCSS変数を更新することで、button-variant(),button-outline-variant(),button-size()mixinで追加したCSSルールを最小減のものにします。

ここでは、BootstrapのCSS変数を、独自のCSS変数とSass変数で再割り当てすることで、ドキュメントに固有のボタンに使用するように、カスタム.btn-*修飾クラスを構築する例を示します。

site/assets/scss/_buttons.scss

.btn-bd-primary {
  --bs-btn-font-weight: 600;
  --bs-btn-color: var(--bs-white);
  --bs-btn-bg: var(--bd-violet-bg);
  --bs-btn-border-color: var(--bd-violet-bg);
  --bs-btn-hover-color: var(--bs-white);
  --bs-btn-hover-bg: #{shade-color($bd-violet, 10%)};
  --bs-btn-hover-border-color: #{shade-color($bd-violet, 10%)};
  --bs-btn-focus-shadow-rgb: var(--bd-violet-rgb);
  --bs-btn-active-color: var(--bs-btn-hover-color);
  --bs-btn-active-bg: #{shade-color($bd-violet, 20%)};
  --bs-btn-active-border-color: #{shade-color($bd-violet, 20%)};
}

Sass変数

scss/_variables.scss

$btn-color:                   var(--#{$prefix}body-color);
$btn-padding-y:               $input-btn-padding-y;
$btn-padding-x:               $input-btn-padding-x;
$btn-font-family:             $input-btn-font-family;
$btn-font-size:               $input-btn-font-size;
$btn-line-height:             $input-btn-line-height;
$btn-white-space:             null; // Set to `nowrap` to prevent text wrapping

$btn-padding-y-sm:            $input-btn-padding-y-sm;
$btn-padding-x-sm:            $input-btn-padding-x-sm;
$btn-font-size-sm:            $input-btn-font-size-sm;

$btn-padding-y-lg:            $input-btn-padding-y-lg;
$btn-padding-x-lg:            $input-btn-padding-x-lg;
$btn-font-size-lg:            $input-btn-font-size-lg;

$btn-border-width:            $input-btn-border-width;

$btn-font-weight:             $font-weight-normal;
$btn-box-shadow:              inset 0 1px 0 rgba($white, .15), 0 1px 1px rgba($black, .075);
$btn-focus-width:             $input-btn-focus-width;
$btn-focus-box-shadow:        $input-btn-focus-box-shadow;
$btn-disabled-opacity:        .65;
$btn-active-box-shadow:       inset 0 3px 5px rgba($black, .125);

$btn-link-color:              var(--#{$prefix}link-color);
$btn-link-hover-color:        var(--#{$prefix}link-hover-color);
$btn-link-disabled-color:     $gray-600;

// Allows for customizing button radius independently from global border radius
$btn-border-radius:           var(--#{$prefix}border-radius);
$btn-border-radius-sm:        var(--#{$prefix}border-radius-sm);
$btn-border-radius-lg:        var(--#{$prefix}border-radius-lg);

$btn-transition:              color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;

$btn-hover-bg-shade-amount:       15%;
$btn-hover-bg-tint-amount:        15%;
$btn-hover-border-shade-amount:   20%;
$btn-hover-border-tint-amount:    10%;
$btn-active-bg-shade-amount:      20%;
$btn-active-bg-tint-amount:       20%;
$btn-active-border-shade-amount:  25%;
$btn-active-border-tint-amount:   10%;

Sass mixins

ボタン用のmixinは、ボタンとボタンの輪郭のバリエーション（どちらも$theme-colorsに基づく）と、ボタンのサイズの3つがあります。

scss/mixins/_buttons.scss

@mixin button-variant(
  $background,
  $border,
  $color: color-contrast($background),
  $hover-background: if($color == $color-contrast-light, shade-color($background, $btn-hover-bg-shade-amount), tint-color($background, $btn-hover-bg-tint-amount)),
  $hover-border: if($color == $color-contrast-light, shade-color($border, $btn-hover-border-shade-amount), tint-color($border, $btn-hover-border-tint-amount)),
  $hover-color: color-contrast($hover-background),
  $active-background: if($color == $color-contrast-light, shade-color($background, $btn-active-bg-shade-amount), tint-color($background, $btn-active-bg-tint-amount)),
  $active-border: if($color == $color-contrast-light, shade-color($border, $btn-active-border-shade-amount), tint-color($border, $btn-active-border-tint-amount)),
  $active-color: color-contrast($active-background),
  $disabled-background: $background,
  $disabled-border: $border,
  $disabled-color: color-contrast($disabled-background)
) {
  --#{$prefix}btn-color: #{$color};
  --#{$prefix}btn-bg: #{$background};
  --#{$prefix}btn-border-color: #{$border};
  --#{$prefix}btn-hover-color: #{$hover-color};
  --#{$prefix}btn-hover-bg: #{$hover-background};
  --#{$prefix}btn-hover-border-color: #{$hover-border};
  --#{$prefix}btn-focus-shadow-rgb: #{to-rgb(mix($color, $border, 15%))};
  --#{$prefix}btn-active-color: #{$active-color};
  --#{$prefix}btn-active-bg: #{$active-background};
  --#{$prefix}btn-active-border-color: #{$active-border};
  --#{$prefix}btn-active-shadow: #{$btn-active-box-shadow};
  --#{$prefix}btn-disabled-color: #{$disabled-color};
  --#{$prefix}btn-disabled-bg: #{$disabled-background};
  --#{$prefix}btn-disabled-border-color: #{$disabled-border};
}

scss/mixins/_buttons.scss

@mixin button-outline-variant(
  $color,
  $color-hover: color-contrast($color),
  $active-background: $color,
  $active-border: $color,
  $active-color: color-contrast($active-background)
) {
  --#{$prefix}btn-color: #{$color};
  --#{$prefix}btn-border-color: #{$color};
  --#{$prefix}btn-hover-color: #{$color-hover};
  --#{$prefix}btn-hover-bg: #{$active-background};
  --#{$prefix}btn-hover-border-color: #{$active-border};
  --#{$prefix}btn-focus-shadow-rgb: #{to-rgb($color)};
  --#{$prefix}btn-active-color: #{$active-color};
  --#{$prefix}btn-active-bg: #{$active-background};
  --#{$prefix}btn-active-border-color: #{$active-border};
  --#{$prefix}btn-active-shadow: #{$btn-active-box-shadow};
  --#{$prefix}btn-disabled-color: #{$color};
  --#{$prefix}btn-disabled-bg: transparent;
  --#{$prefix}btn-disabled-border-color: #{$color};
  --#{$prefix}gradient: none;
}

scss/mixins/_buttons.scss

@mixin button-size($padding-y, $padding-x, $font-size, $border-radius) {
  --#{$prefix}btn-padding-y: #{$padding-y};
  --#{$prefix}btn-padding-x: #{$padding-x};
  @include rfs($font-size, --#{$prefix}btn-font-size);
  --#{$prefix}btn-border-radius: #{$border-radius};
}

Sassループ

ボタンのバリエーション（通常のボタンとアウトラインボタン）は、$theme-colorsマップとそれぞれのmixinを使ってscss/_buttons.scssに修飾クラスを生成します。

scss/_buttons.scss

@each $color, $value in $theme-colors {
  .btn-#{$color} {
    @if $color == "light" {
      @include button-variant(
        $value,
        $value,
        $hover-background: shade-color($value, $btn-hover-bg-shade-amount),
        $hover-border: shade-color($value, $btn-hover-border-shade-amount),
        $active-background: shade-color($value, $btn-active-bg-shade-amount),
        $active-border: shade-color($value, $btn-active-border-shade-amount)
      );
    } @else if $color == "dark" {
      @include button-variant(
        $value,
        $value,
        $hover-background: tint-color($value, $btn-hover-bg-tint-amount),
        $hover-border: tint-color($value, $btn-hover-border-tint-amount),
        $active-background: tint-color($value, $btn-active-bg-tint-amount),
        $active-border: tint-color($value, $btn-active-border-tint-amount)
      );
    } @else {
      @include button-variant($value, $value);
    }
  }
}

@each $color, $value in $theme-colors {
  .btn-outline-#{$color} {
    @include button-outline-variant($value);
  }
}