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

CSS変数(CSS Variables)

BootstrapのCSSカスタムプロパティを使用して、高速かつ将来を見据えた設計と開発を行う。

※"v5.2.0"での変更はv5.2.0-beta1での変更も含みます。
※"v5.3.0"での変更はv5.3.0-alpha版、v5.3.0-beta版での変更も含みます。
※参考

Bootstrapは、Sassを再コンパイルすることなくリアルタイムでカスタマイズできるように、コンパイルされたCSSに多くのCSSカスタムプロパティ(変数)を組み込んでいる。これらを使用すると、ブラウザのインスペクタ、コードサンドボックス、一般的なプロトタイピングで作業するときに、テーマカラー、プライマリフォントスタックなどの一般的に使用される値に簡単にアクセスできる。

サードパーティのCSSとの競合を避けるために、すべてのカスタムプロパティの前には bs- が付く。

root変数(Root variables)v5.3.0変更

ここには、BootstrapのCSSが読み込まれる任意の場所にアクセスできる変数を組み込む(:root は必須)。これらは _root.scss ファイルにあり、コンパイルされた dist ファイルに組み込まれる。

デフォルト(Default)v5.3.0項目として独立

これらのCSS変数は、カラーモードに関係なく、どこでも利用できる。

デフォルトの設定
scss/_root.scss を出力したもの:root,
[data-bs-theme=light] {
  --bs-blue: #0d6efd;
  --bs-indigo: #6610f2;
  --bs-purple: #6f42c1;
  --bs-pink: #d63384;
  --bs-red: #dc3545;
  --bs-orange: #fd7e14;
  --bs-yellow: #ffc107;
  --bs-green: #198754;
  --bs-teal: #20c997;
  --bs-cyan: #0dcaf0;
  --bs-black: #000;
  --bs-white: #fff;
  --bs-gray: #6c757d;
  --bs-gray-dark: #343a40;
  --bs-gray-100: #f8f9fa;
  --bs-gray-200: #e9ecef;
  --bs-gray-300: #dee2e6;
  --bs-gray-400: #ced4da;
  --bs-gray-500: #adb5bd;
  --bs-gray-600: #6c757d;
  --bs-gray-700: #495057;
  --bs-gray-800: #343a40;
  --bs-gray-900: #212529;
  --bs-primary: #0d6efd;
  --bs-secondary: #6c757d;
  --bs-success: #198754;
  --bs-info: #0dcaf0;
  --bs-warning: #ffc107;
  --bs-danger: #dc3545;
  --bs-light: #f8f9fa;
  --bs-dark: #212529;
  --bs-primary-rgb: 13, 110, 253;
  --bs-secondary-rgb: 108, 117, 125;
  --bs-success-rgb: 25, 135, 84;
  --bs-info-rgb: 13, 202, 240;
  --bs-warning-rgb: 255, 193, 7;
  --bs-danger-rgb: 220, 53, 69;
  --bs-light-rgb: 248, 249, 250;
  --bs-dark-rgb: 33, 37, 41;
  --bs-primary-text: #0a58ca;
  --bs-secondary-text: #6c757d;
  --bs-success-text: #146c43;
  --bs-info-text: #087990;
  --bs-warning-text: #997404;
  --bs-danger-text: #b02a37;
  --bs-light-text: #6c757d;
  --bs-dark-text: #495057;
  --bs-primary-bg-subtle: #cfe2ff;
  --bs-secondary-bg-subtle: #f8f9fa;
  --bs-success-bg-subtle: #d1e7dd;
  --bs-info-bg-subtle: #cff4fc;
  --bs-warning-bg-subtle: #fff3cd;
  --bs-danger-bg-subtle: #f8d7da;
  --bs-light-bg-subtle: #fcfcfd;
  --bs-dark-bg-subtle: #ced4da;
  --bs-primary-border-subtle: #9ec5fe;
  --bs-secondary-border-subtle: #e9ecef;
  --bs-success-border-subtle: #a3cfbb;
  --bs-info-border-subtle: #9eeaf9;
  --bs-warning-border-subtle: #ffe69c;
  --bs-danger-border-subtle: #f1aeb5;
  --bs-light-border-subtle: #e9ecef;
  --bs-dark-border-subtle: #adb5bd;
  --bs-white-rgb: 255, 255, 255;
  --bs-black-rgb: 0, 0, 0;
  --bs-body-color-rgb: 33, 37, 41;
  --bs-body-bg-rgb: 255, 255, 255;
  --bs-font-sans-serif: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", "Noto Sans", "Liberation Sans", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
  --bs-font-monospace: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
  --bs-gradient: linear-gradient(180deg, rgba(255, 255, 255, 0.15), rgba(255, 255, 255, 0));
  --bs-body-font-family: var(--bs-font-sans-serif);
  --bs-body-font-size: 1rem;
  --bs-body-font-weight: 400;
  --bs-body-line-height: 1.5;
  --bs-body-color: #212529;
  --bs-emphasis-color: #000;
  --bs-emphasis-color-rgb: 0, 0, 0;
  --bs-secondary-color: rgba(33, 37, 41, 0.75);
  --bs-secondary-color-rgb: 33, 37, 41;
  --bs-secondary-bg: #e9ecef;
  --bs-secondary-bg-rgb: 233, 236, 239;
  --bs-tertiary-color: rgba(33, 37, 41, 0.5);
  --bs-tertiary-color-rgb: 33, 37, 41;
  --bs-tertiary-bg: #f8f9fa;
  --bs-tertiary-bg-rgb: 248, 249, 250;
  --bs-body-bg: #fff;
  --bs-body-bg-rgb: 255, 255, 255;
  --bs-link-color: #0d6efd;
  --bs-link-color-rgb: 13, 110, 253;
  --bs-link-decoration: underline;
  --bs-link-hover-color: #0a58ca;
  --bs-link-hover-color-rgb: 10, 88, 202;
  --bs-code-color: #d63384;
  --bs-highlight-bg: #fff3cd;
  --bs-border-width: 1px;
  --bs-border-style: solid;
  --bs-border-color: #dee2e6;
  --bs-border-color-translucent: rgba(0, 0, 0, 0.175);
  --bs-border-radius: 0.375rem;
  --bs-border-radius-sm: 0.25rem;
  --bs-border-radius-lg: 0.5rem;
  --bs-border-radius-xl: 1rem;
  --bs-border-radius-2xl: 2rem;
  --bs-border-radius-pill: 50rem;
  --bs-box-shadow: 0 0.5rem 1rem rgba(var(--bs-body-color-rgb), 0.15);
  --bs-box-shadow-sm: 0 0.125rem 0.25rem rgba(var(--bs-body-color-rgb), 0.075);
  --bs-box-shadow-lg: 0 1rem 3rem rgba(var(--bs-body-color-rgb), 0.175);
  --bs-box-shadow-inset: inset 0 1px 2px rgba(var(--bs-body-color-rgb), 0.075);
  --bs-form-control-bg: var(--bs-body-bg);
  --bs-form-control-disabled-bg: var(--bs-secondary-bg);
  --bs-breakpoint-xs: 0;
  --bs-breakpoint-sm: 576px;
  --bs-breakpoint-md: 768px;
  --bs-breakpoint-lg: 992px;
  --bs-breakpoint-xl: 1200px;
  --bs-breakpoint-xxl: 1400px;
}
【注意】
  • --bs-heading-color 変数がv5.3.0で更新されダークモードの新設に伴いCSS変数として復活したが、デフォルトのroot変数には存在しない(CSS変数の出力を試みる前に関連するSass変数である $headings-colornull 値があるかどうかを確認し、次にCSS変数を inherit 値で使用し、元の動作を維持しつつ再定義も可能にする仕様)
【変更履歴】
  • 【v5.0.0-alpha1】
    • すべての変数に bs- の接頭辞を追加
    • 背景をグラデーション化する変数(--bs-gradient)が追加
    • ブレークポイント関連の変数(--breakpoint-**)は削除
  • 【v5.0.0-alpha3】(v4.6.0でバックポート)
    • --bs-font-sans-serif$font-family-sans-serif)に "Liberation Sans"(Ubuntu用sans-serif)が追加
  • 【v5.1.0】
    • グレースケールカラーの変数(--bs-gray-*), RGBカラーの変数(--bs-{color}-rgb), <body> スタイルの変数(--bs-body-*)が追加
  • 【v5.1.1】
    • --bs-body-color-rgb を追加
    • --bs-body-bg-rgb の値を変更(33, 37, 41255, 255, 255
  • 【v5.2.0】
    • --bs-black, --bs-border-*, --bs-link-*, --bs-code-color, --bs-highlight-bg を追加(※--bs-heading-color はv5.2.0-beta1で追加したがv5.2.0で削除)
  • 【v5.3.0】
    • カラーモードの新設に伴い、従来の変数をライトモード([data-bs-theme=light])用にし、ダークモード([data-bs-theme=dark])用の変数を追加
    • ブレークポイント関連の変数(--bs-breakpoint-**)が復活(メディアクエリではサポートされていないため使用不可
    • 新カラーシステムの導入に伴い、淡いテーマカラーの変数(--bs-{themecolor}-text, --bs-{themecolor}-bg-subtle), 淡い罫線の色の変数(--bs-{themecolor}-border-subtle), 強調文字カラーの変数(--bs-emphasis-color), 二次Bodyカラーの変数(--bs-secondary-color, --bs-secondary-bg), 三次Bodyカラーの変数(--bs-tertiary-color, --bs-tertiary-bg)を追加
    • リンク装飾の変数(--bs-link-decoration), ボックスシャドウの変数(--bs-box-shadow-*), フォームコントロールの変数(--bs-form-control-*-bg)などを追加

ダークモード(Dark mode)v5.3.0新設

これらの変数は、構築済のダークモードに組み込まれている。

デフォルトの設定
scss/_root.scss を出力したもの[data-bs-theme=dark] {
  --bs-body-color: #adb5bd;
  --bs-body-color-rgb: 173, 181, 189;
  --bs-body-bg: #212529;
  --bs-body-bg-rgb: 33, 37, 41;
  --bs-emphasis-color: #f8f9fa;
  --bs-emphasis-color-rgb: 248, 249, 250;
  --bs-secondary-color: rgba(173, 181, 189, 0.75);
  --bs-secondary-color-rgb: 173, 181, 189;
  --bs-secondary-bg: #343a40;
  --bs-secondary-bg-rgb: 52, 58, 64;
  --bs-tertiary-color: rgba(173, 181, 189, 0.5);
  --bs-tertiary-color-rgb: 173, 181, 189;
  --bs-tertiary-bg: #2b3035;
  --bs-tertiary-bg-rgb: 43, 48, 53;
  --bs-emphasis-color: #fff;
  --bs-primary-text: #6ea8fe;
  --bs-secondary-text: #dee2e6;
  --bs-success-text: #75b798;
  --bs-info-text: #6edff6;
  --bs-warning-text: #ffda6a;
  --bs-danger-text: #ea868f;
  --bs-light-text: #f8f9fa;
  --bs-dark-text: #dee2e6;
  --bs-primary-bg-subtle: #031633;
  --bs-secondary-bg-subtle: #212529;
  --bs-success-bg-subtle: #051b11;
  --bs-info-bg-subtle: #032830;
  --bs-warning-bg-subtle: #332701;
  --bs-danger-bg-subtle: #2c0b0e;
  --bs-light-bg-subtle: #343a40;
  --bs-dark-bg-subtle: #1a1d20;
  --bs-primary-border-subtle: #084298;
  --bs-secondary-border-subtle: #495057;
  --bs-success-border-subtle: #0f5132;
  --bs-info-border-subtle: #055160;
  --bs-warning-border-subtle: #664d03;
  --bs-danger-border-subtle: #842029;
  --bs-light-border-subtle: #495057;
  --bs-dark-border-subtle: #343a40;
  --bs-heading-color: #fff;
  --bs-link-color: #6ea8fe;
  --bs-link-hover-color: #9ec5fe;
  --bs-link-color-rgb: 110, 168, 254;
  --bs-link-hover-color-rgb: 158, 197, 254;
  --bs-code-color: #e685b5;
  --bs-border-color: #495057;
  --bs-border-color-translucent: rgba(255, 255, 255, 0.15);
}

コンポーネント変数(Component variables)

Bootstrap5は、様々なコンポーネントのローカル変数としてカスタムプロパティをどんどん利用している。こうして、コンパイルされるCSSを減らし、入れ子になったテーブルなどでスタイルが継承されないようにし、Sassコンパイル後にBootstrapコンポーネントの基本的なスタイル変更と拡張を可能にする。

CSS変数の使用方法の洞察については、テーブルの解説RebootのCSS変数に記載。v5.2.0以降ではナビゲーションバーもCSS変数を使用している。また、グリッド全体でCSS変数を使用し、主に新しいオプトインCSSグリッドをガター用に使用しており、将来的にはコンポーネントの使用量は増える。

可能な限り、CSS変数を基本のコンポーネントレベルに割り当てる(例:ナビゲーションバーとそのサブコンポーネントの場合は .navbar)。これにより、カスタマイズする場所と方法の推測が減り、将来の更新でチームが簡単に変更できるようになる。

※CSS変数によるカスタマイズ例

接頭辞(Prefix)v5.2.0新設、設定変更

ほとんどのCSS変数は、独自のコードベースとの衝突を回避するために接頭辞(プレフィックス)を使用。この接頭辞は、すべてのCSS変数に必要な -- に追加される。

scss/_variables.scss 内の $prefix Sass変数を使用して接頭辞をカスタマイズする。デフォルトでは、bs- に設定されている(末尾のダッシュに注意)。

【変更履歴】
  • 【v5.2.0】
    • 従来、$variable-prefix だったが、$prefix に省略

実例(Examples)

CSS変数は、Sassの変数と同様の柔軟性を提供するが、ブラウザに提供される前にコンパイルする必要はない。実例では、CSS変数を使用してページのフォントとリンクスタイルをリセット。

Bootstrap5.xの設定例 緑背景が変更箇所
custom.cssbody {
  font: 1rem/1.5 var(--bs-font-family-sans-serif);
}
a {
  color: var(--bs-blue);
}
※Bootstrap4.xの設定例
custom.cssbody {
  font: 1rem/1.5 var(--font-family-sans-serif);
}
a {
  color: var(--blue);
}
【設定】
  • bootstrap.css内に記載されている変数がカスタムのCSSファイルで var(--bs-{変数名}) として使用可能
【変更履歴】
  • 【v5.0.0-alpha1】
    • var(--{変数名})var(--bs-{変数名})

グリッドブレークポイント(Grid breakpoints)v5.1.0追加

グリッドブレークポイントをCSS変数(xs を除く)として組み込むが、CSS変数はメディアクエリでは機能しないので注意。これは変数のCSS仕様の仕様によるものだが、env() 変数のサポートにより今後数年間で変更される可能性がある。いくつかの役立つリンクについては、このStackOverflowの回答をご確認下さい。その間JavaScriptだけでなく、他のCSSの状況でもこれらの変数を使用できる。