ユーティリティAPI（Utility API） v5.0.0-alpha1新設

Bootstrapユーティリティは、ユーティリティAPIを使用して生成され、Sassを経由してユーティリティクラスのデフォルトセットの変更や拡張に使用できる。このユーティリティAPIは、さまざまなオプションを備えたクラスのファミリーを生成するための一連のSassマップと関数に基づく。Sassマップに慣れていない場合は、公式のSassドキュメントを参照。

scss/_utilities.scss ファイルにある $utilities マップにはすべてのBootstrapユーティリティが集約されており、カスタムした $utilities マップが存在する場合は後からマージされる。ユーティリティマップには、以下のオプションを受け入れるユーティリティグループのキー付きリストが集約されている。

 

APIの説明（API explained）

すべてのユーティリティ変数は、_utilities.scss スタイルシート内の $utilities 変数に追加される。ユーティリティの各グループは以下のようになる：

設定例

コピー$utilities: (
	"opacity": (
		property: opacity,
		values: (
			0: 0,
			25: .25,
			50: .5,
			75: .75,
			100: 1,
		)
	)
 );

以下を出力：

css.opacity-0 { opacity: 0; }
.opacity-25 { opacity: .25; }
.opacity-50 { opacity: .5; }
.opacity-75 { opacity: .75; }
.opacity-100 { opacity: 1; }

カスタム・クラスプレフィックス（Custom class prefix）

コンパイルされたCSSで使用されるクラスプレフィックスを変更するには、class オプションを使用：

設定例

コピー$utilities: (
	"opacity": (
		property: opacity,
		class: o,
		values: (
			0: 0,
			25: .25,
			50: .5,
			75: .75,
			100: 1,
		)
	)
 );

出力：

css.o-0 { opacity: 0; }
.o-25 { opacity: .25; }
.o-50 { opacity: .5; }
.o-75 { opacity: .75; }
.o-100 { opacity: 1; }

状態（States）v5.0.0-beta1追加

state オプションを使用して、疑似クラスのバリエーションを生成。疑似クラスの例は、:hover と :focus。状態のリストが提供されると、その疑似クラスのクラス名が作成される。例えば、hoverの不透明度を変更するには、state: hover を追加すると、コンパイルされたCSSに .opacity-hover:hoverr が組み込まれる。

複数の疑似クラスが必要なら、状態のリストをスペースで区切って使用する： state: hover focus

設定例

コピー$utilities: (
	"opacity": (
		property: opacity,
		class: opacity,
		state: hover,
		values: (
			0: 0,
			25: .25,
			50: .5,
			75: .75,
			100: 1,
		)
	)
);

出力：

css.opacity-0-hover:hover { opacity: 0 !important; }
.opacity-25-hover:hover { opacity: .25 !important; }
.opacity-50-hover:hover { opacity: .5 !important; }
.opacity-75-hover:hover { opacity: .75 !important; }
.opacity-100-hover:hover { opacity: 1 !important; }

レスポンシブ・ユーティリティ（Responsive utilities）

レスポンシブブール値を追加して、すべてのブレークポイントにわたってレスポンシブユーティリティ（.opacity-md-25 など）を生成。

設定例

コピー$utilities: (
	"opacity": (
		property: opacity,
		responsive: true,
		values: (
			0: 0,
			25: .25,
			50: .5,
			75: .75,
			100: 1,
		)
	)
 );

出力：

css.opacity-0 { opacity: 0; }
.opacity-25 { opacity: .25 !important; }
.opacity-50 { opacity: .5 !important; }
.opacity-75 { opacity: .75 !important; }
.opacity-100 { opacity: 1 !important; }

@media (min-width: 576px) {
	.opacity-sm-0 { opacity: 0 !important; }
	.opacity-sm-25 { opacity: .25 !important; }
	.opacity-sm-50 { opacity: .5 !important; }
	.opacity-sm-75 { opacity: .75 !important; }
	.opacity-sm-100 { opacity: 1 !important; }
}

@media (min-width: 768px) {
	.opacity-md-0 { opacity: 0 !important; }
	.opacity-md-25 { opacity: .25 !important; }
	.opacity-md-50 { opacity: .5 !important; }
	.opacity-md-75 { opacity: .75 !important; }
	.opacity-md-100 { opacity: 1 !important; }
}

@media (min-width: 992px) {
	.opacity-lg-0 { opacity: 0 !important; }
	.opacity-lg-25 { opacity: .25 !important; }
	.opacity-lg-50 { opacity: .5 !important; }
	.opacity-lg-75 { opacity: .75 !important; }
	.opacity-lg-100 { opacity: 1 !important; }
}

@media (min-width: 1200px) {
	.opacity-xl-0 { opacity: 0 !important; }
	.opacity-xl-25 { opacity: .25 !important; }
	.opacity-xl-50 { opacity: .5 !important; }
	.opacity-xl-75 { opacity: .75 !important; }
	.opacity-xl-100 { opacity: 1 !important; }
}

@media (min-width: 1400px) {
	.opacity-xxl-0 { opacity: 0 !important; }
	.opacity-xxl-25 { opacity: .25 !important; }
	.opacity-xxl-50 { opacity: .5 !important; }
	.opacity-xxl-75 { opacity: .75 !important; }
	.opacity-xxl-100 { opacity: 1 !important; }
}

ユーティリティの変更（Changing utilities）

同じキーを使用して既存のユーティリティを再定義。例えば、追加のレスポンシブオーバーフローユーティリティクラスが必要な場合は、次のように実行できる：

設定例

コピー$utilities: (
  "overflow": (
    responsive: true,
    property: overflow,
    values: visible hidden scroll auto,
  ),
);

出力：

css.overflow-visible {
	overflow: visible;
}
.overflow-hidden {
	overflow: hidden;
}
.overflow-scroll {
	overflow: scroll;
}
.overflow-auto {
	overflow: auto;
}
@media (min-width: 576px) {
	.overflow-sm-visible {
		overflow: visible;
	}
	.overflow-sm-hidden {
		overflow: hidden;
	}
	.overflow-sm-scroll {
		overflow: scroll;
	}
	.overflow-sm-auto {
		overflow: auto;
	}
}
@media (min-width: 768px) {
	.overflow-md-visible {
		overflow: visible;
	}
	.overflow-md-hidden {
		overflow: hidden;
	}
	.overflow-md-scroll {
		overflow: scroll;
	}
	.overflow-md-auto {
		overflow: auto;
	}
}
@media (min-width: 992px) {
	.overflow-lg-visible {
		overflow: visible;
	}
	.overflow-lg-hidden {
		overflow: hidden;
	}
	.overflow-lg-scroll {
		overflow: scroll;
	}
	.overflow-lg-auto {
		overflow: auto;
	}
}
@media (min-width: 1200px) {
	.overflow-xl-visible {
		overflow: visible;
	}
	.overflow-xl-hidden {
		overflow: hidden;
	}
	.overflow-xl-scroll {
		overflow: scroll;
	}
	.overflow-xl-auto {
		overflow: auto;
	}
@media (min-width: 1400px) {
	.overflow-xxl-visible {
		overflow: visible;
	}
	.overflow-xxl-hidden {
		overflow: hidden;
	}
	.overflow-xxl-scroll {
		overflow: scroll;
	}
	.overflow-xxl-auto {
		overflow: auto;
	}
}

印刷ユーティリティ（Print utilities）

print オプションを有効にすると、印刷用のユーティリティクラスも生成できる。これは、 @media print { ... } メディアクエリ内でのみ適用される。

設定例

コピー$utilities: (
	"opacity": (
		property: opacity,
		class: o,
		print: true,
		values: (
			0: 0,
			25: .25,
			50: .5,
			75: .75,
			100: 1,
		)
	)
 );

出力：

css.opacity-0 { opacity: 0; }
.opacity-25 { opacity: .25; }
.opacity-50 { opacity: .5; }
.opacity-75 { opacity: .75; }
.opacity-100 { opacity: 1; }

@media print {
	.opacity-print-0 { opacity: 0; }
	.opacity-print-25 { opacity: .25; }
	.opacity-print-50 { opacity: .5; }
	.opacity-print-75 { opacity: .75; }
	.opacity-print-100 { opacity: 1; }
}

 

優先度（Importance）v5.0.2追加

APIによって生成されるすべてのユーティリティには、意図したとおりにコンポーネントと修飾子クラスを再定義するために !important を組み込んでいる。scss/_variables.scss ファイル内の $enable-important-utilities 変数（デフォルトは true）を使用して、この設定をグローバルで切り替えられる。

 

APIの使用（Using the API）v5.0.0-alpha3追加、v5.0.0-beta2変更

ユーティリティAPIの仕組みを理解したところで、独自のカスタムクラスを追加し、デフォルトのユーティリティを変更する方法を学習。

ユーティリティを追加（Add utilities）

新しいユーティリティは、map-merge を使用してデフォルトの $utilities マップに追加できる。必要なSassファイルと _utilities.scss が最初にインポートされていることを確認してから、map-merge を使用してユーティリティを追加。例えば、3つの値を持つレスポンシブ cursor ユーティリティを追加する方法は以下のとおり。

設定例 緑背景がv5.0.0-beta2での変更箇所

custom.scssコピー@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
	$utilities,
	(
		"cursor": (
			property: cursor,
			class: cursor,
			responsive: true,
			values: auto pointer grab,
		)
	)
);

ユーティリティを変更（Modify utilities）

map-get 関数と map-merge 関数を使用して、デフォルトの $utilities マップの既存のユーティリティを変更。以下の例では、width ユーティリティに値を追加。最初の map-merge から始めて、変更するユーティリティを指定。そこから、map-get を使用して入れ子になった "width" マップをフェッチし、ユーティリティのオプションと値にアクセスして変更。

設定例 緑背景がv5.0.0-beta2での変更箇所

custom.scssコピー@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
	$utilities,
	(
		"width": map-merge(
			map-get($utilities, "width"),
			(
				values: map-merge(
					map-get(map-get($utilities, "width"), "values"),
					(10: 10%),
				),
			),
		),
	)
);

レスポンシブを有効にする（Enable responsive）v5.0.2追加

デフォルトで現在レスポンシブではない既存のユーティリティセットのレスポンシブクラスを有効にする。例えば、border クラスをレスポンシブにするには：

設定例

custom.scssコピー@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
	$utilities, (
		"border": map-merge(
			map-get($utilities, "border"),
			( responsive: true ),
		),
	)
);

これにより、ブレークポイントごとに .border と .border-0 のレスポンシブのバリエーションが生成される。生成されたCSSは次のようになる：

設定例

css.border { ... }
.border-0 { ... }

@media (min-width: 576px) {
	.border-sm { ... }
	.border-sm-0 { ... }
}

@media (min-width: 768px) {
	.border-md { ... }
	.border-md-0 { ... }
}

@media (min-width: 992px) {
	.border-lg { ... }
	.border-lg-0 { ... }
}

@media (min-width: 1200px) {
	.border-xl { ... }
	.border-xl-0 { ... }
}

@media (min-width: 1400px) {
	.border-xxl { ... }
	.border-xxl-0 { ... }
}

ユーティリティの名前を変更（Rename utilities）v5.0.0-beta2追加

v4ユーティリティがないとか別の命名規則に慣れているのなら、ユーティリティAPIを使用して、特定のユーティリティの結果のクラスが再定義できる。例えば、.ms-* ユーティリティの名前を古い .ml-* に変更：

設定例

custom.scssコピー@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
  $utilities, (
    "margin-start": map-merge(
      map-get($utilities, "margin-start"),
      ( class: ml ),
    ),
  )
);

ユーティリティを削除（Remove utilities）

グループキーを null に設定して、デフォルトのユーティリティをすべて削除。例えば、すべての width ユーティリティを削除するには、$utilities map-merge を作成し、その中に "width": null を追加。

設定例 緑背景がv5.0.0-beta2での変更箇所

custom.scssコピー@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
	$utilities,
	(
		"width": null
	)
);

RTLのユーティリティを削除（Remove utility in RTL）v5.0.0-beta1追加

一部のエッジケースでは、アラビア語の改行など、RTLのスタイルが困難になる。従って、rtl オプションを false に設定することにより、出力時にRTLのユーティリティを削除できる。

設定例

コピー$utilities: (
	"word-wrap": (
		property: word-wrap word-break,
		class: text,
		values: (break: break-word),
		rtl: false
	),
);

出力：

css/* rtl:begin:remove */
.text-break {
	word-wrap: break-word !important;
	word-break: break-word !important;
}
/* rtl:end:remove */

RTLCSS削除制御ディレクティブのおかげで、これはRTLに何も出力しない。