メインコンテンツにスキップ ドキュメントナビゲーションにスキップ

ボタン

Bootstrapのカスタムボタンスタイルを使用して、フォーム、ダイアログなどで、複数のサイズ、状態などをサポートするアクションボタンを作成します。

基本クラス

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

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

`.btn` クラスは、ボタンのバリアントと組み合わせて使用するか、独自のカスタムスタイルの基礎として使用することを目的としています。

`.btn` クラスを単独で使用する場合、少なくともいくつかの明示的な `:focus` または `:focus-visible` スタイルを定義することを忘れないでください。

バリアント

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"` を指定して、スクリーンリーダーなどの支援技術にその目的を適切に伝える必要があります。

リンク
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` クラスを追加する必要があります。
  • アンカーボタンのすべての `pointer-events` を無効にするために、いくつかの将来を見据えたスタイルが含まれています。
  • `<a>` を使用した無効化されたボタンには、支援技術に要素の状態を示すために `aria-disabled="true"` 属性を含める必要があります。
  • `<a>` を使用する無効化されたボタンには、`href` 属性を含める_べきではありません_。
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を使用して機能を完全に無効にします。

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>

ブロックボタン

表示とギャップユーティリティを組み合わせて、Bootstrap 4のような全幅の「ブロックボタン」のレスポンシブスタックを作成します。 ボタン固有のクラスではなくユーティリティを使用することで、間隔、配置、レスポンシブな動作をより細かく制御できます。

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` ブレークポイントまではボタンを縦に積み重ね、`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>

グリッドカラム幅クラスを使用して、ブロックボタンの幅を調整できます。 たとえば、半分の幅の「ブロックボタン」の場合は、`.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>

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

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
<p class="d-inline-flex gap-1">
  <button type="button" class="btn" data-bs-toggle="button">Toggle button</button>
  <button type="button" class="btn active" data-bs-toggle="button" aria-pressed="true">Active toggle button</button>
  <button type="button" class="btn" disabled data-bs-toggle="button">Disabled toggle button</button>
</p>
<p class="d-inline-flex gap-1">
  <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>
</p>
html
<p class="d-inline-flex gap-1">
  <a href="#" class="btn" role="button" data-bs-toggle="button">Toggle link</a>
  <a href="#" class="btn active" role="button" data-bs-toggle="button" aria-pressed="true">Active toggle link</a>
  <a class="btn disabled" aria-disabled="true" role="button" data-bs-toggle="button">Disabled toggle link</a>
</p>
<p class="d-inline-flex gap-1">
  <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>
</p>

メソッド

たとえば、ボタンコンストラクタを使用してボタンインスタンスを作成できます

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

例えば、すべてのボタンを切り替えるには

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

CSS

変数

v5.2.0 で追加

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

--#{$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-* 修飾子クラスは、button-variant()button-outline-variant()、および button-size() ミックスインを使用して追加のCSSルールを最小限に抑えるために、適切なCSS変数を更新します。

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

.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変数

$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;
$btn-link-focus-shadow-rgb:   to-rgb(mix(color-contrast($link-color), $link-color, 15%));

// 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ミックスイン

ボタンには3つのミックスインがあります。ボタンとボタンアウトラインバリアントミックスイン(どちらも $theme-colors に基づく)と、ボタンサイズミックスインです。

@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};
}
@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;
}
@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 マップを使用して、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);
  }
}