ユーティリティ API
ユーティリティ API は、ユーティリティ クラスを生成するための Sass ベースのツールです。
ブートストラップ ユーティリティは、ユーティリティ API で生成され、Sass を介してユーティリティ クラスのデフォルト セットを変更または拡張するために使用できます。私たちのユーティリティ API は、さまざまなオプションを持つクラスのファミリを生成するための一連の Sass マップと関数に基づいています。Sass マップに慣れていない場合は、Sass の公式ドキュメントを読んで開始してください。
マップにはすべてのユーティリティが含まれており、後でカスタムマップが存在する場合$utilities
はマージされます。$utilities
ユーティリティ マップには、次のオプションを受け入れるユーティリティ グループのキー付きリストが含まれています。
オプション | タイプ | デフォルト値 | 説明 |
---|---|---|---|
property |
必須 | – | プロパティの名前。これは、文字列または文字列の配列 (水平方向のパディングやマージンなど) にすることができます。 |
values |
必須 | – | 値のリスト、またはクラス名を値と同じにしたくない場合はマップ。をマップ キーとして使用するnull と、コンパイルされません。 |
class |
オプション | ヌル | 生成されたクラスの名前。指定されておらずproperty 、文字列の配列である場合は、class デフォルトで配列の最初の要素になりますproperty 。 |
css-var |
オプション | false |
CSS ルールの代わりに CSS 変数を生成するブール値。 |
local-vars |
オプション | ヌル | CSS ルールに加えて生成するローカル CSS 変数のマップ。 |
state |
オプション | ヌル | 生成する疑似クラスバリアント (:hover または など:focus ) のリスト。 |
responsive |
オプション | false |
レスポンシブ クラスを生成する必要があるかどうかを示すブール値。 |
rfs |
オプション | false |
RFS で流体の再スケーリングを有効にするブール値。 |
print |
オプション | false |
印刷クラスを生成する必要があるかどうかを示すブール値。 |
rtl |
オプション | true |
ユーティリティを RTL に保持する必要があるかどうかを示すブール値。 |
API の説明
すべてのユーティリティ変数は、スタイルシート$utilities
内の変数に追加され_utilities.scss
ます。ユーティリティの各グループは次のようになります。
$utilities: (
"opacity": (
property: opacity,
values: (
0: 0,
25: .25,
50: .5,
75: .75,
100: 1,
)
)
);
次を出力します。
.opacity-0 { opacity: 0; }
.opacity-25 { opacity: .25; }
.opacity-50 { opacity: .5; }
.opacity-75 { opacity: .75; }
.opacity-100 { opacity: 1; }
財産
どのユーティリティでも必要なproperty
キーを設定する必要があり、有効な CSS プロパティが含まれている必要があります。このプロパティは、生成されたユーティリティのルールセットで使用されます。class
キーを省略した場合は、デフォルトのクラス名にもなります。text-decoration
ユーティリティを考えてみましょう:
$utilities: (
"text-decoration": (
property: text-decoration,
values: none underline line-through
)
);
出力:
.text-decoration-none { text-decoration: none !important; }
.text-decoration-underline { text-decoration: underline !important; }
.text-decoration-line-through { text-decoration: line-through !important; }
値
キーを使用してvalues
、指定された のどの値をproperty
生成されたクラス名とルールで使用するかを指定します。リストまたはマップにすることができます (ユーティリティまたは Sass 変数で設定)。
リストとして、text-decoration
utilityのように:
values: none underline line-through
opacity
ユーティリティのように、マップとして:
values: (
0: 0,
25: .25,
50: .5,
75: .75,
100: 1,
)
position
ユーティリティのように、リストまたはマップを設定する Sass 変数として:
values: $position-values
クラス
このclass
オプションを使用して、コンパイルされた CSS で使用されるクラス プレフィックスを変更します。たとえば、 から に変更する.opacity-*
には.o-*
:
$utilities: (
"opacity": (
property: opacity,
class: o,
values: (
0: 0,
25: .25,
50: .5,
75: .75,
100: 1,
)
)
);
出力:
.o-0 { opacity: 0 !important; }
.o-25 { opacity: .25 !important; }
.o-50 { opacity: .5 !important; }
.o-75 { opacity: .75 !important; }
.o-100 { opacity: 1 !important; }
CSS 変数ユーティリティ
css-var
boolean オプションを に設定すると、API は通常のルールtrue
ではなく、指定されたセレクターのローカル CSS 変数を生成します。私たちのユーティリティproperty: value
を考えてみましょう:.text-opacity-*
$utilities: (
"text-opacity": (
css-var: true,
class: text-opacity,
values: (
25: .25,
50: .5,
75: .75,
100: 1
)
),
);
出力:
.text-opacity-25 { --bs-text-opacity: .25; }
.text-opacity-50 { --bs-text-opacity: .5; }
.text-opacity-75 { --bs-text-opacity: .75; }
.text-opacity-100 { --bs-text-opacity: 1; }
ローカル CSS 変数
このオプションを使用してlocal-vars
、ユーティリティ クラスのルールセット内でローカル CSS 変数を生成する Sass マップを指定します。生成された CSS ルールでこれらのローカル CSS 変数を使用するには、追加の作業が必要になる場合があることに注意してください。たとえば、.bg-*
次のユーティリティを考えてみましょう。
$utilities: (
"background-color": (
property: background-color,
class: bg,
local-vars: (
"bg-opacity": 1
),
values: map-merge(
$utilities-bg-colors,
(
"transparent": transparent
)
)
)
);
出力:
.bg-primary {
--bs-bg-opacity: 1;
background-color: rgba(var(--bs-primary-rgb), var(--bs-bg-opacity)) !important;
}
州
オプションを使用して、state
疑似クラスのバリエーションを生成します。疑似クラスの例は:hover
と:focus
です。状態のリストが提供されると、その疑似クラスのクラス名が作成されます。たとえば、ホバー時に不透明度を変更するには、追加して、コンパイル済みの CSSstate: hover
を取得します。.opacity-hover:hover
複数の疑似クラスが必要ですか? スペースで区切られた状態のリストを使用します: state: hover focus
.
$utilities: (
"opacity": (
property: opacity,
class: opacity,
state: hover,
values: (
0: 0,
25: .25,
50: .5,
75: .75,
100: 1,
)
)
);
出力:
.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
でレスポンシブ ユーティリティ (例: .opacity-md-25
) を生成します。
$utilities: (
"opacity": (
property: opacity,
responsive: true,
values: (
0: 0,
25: .25,
50: .5,
75: .75,
100: 1,
)
)
);
出力:
.opacity-0 { opacity: 0 !important; }
.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; }
}
印刷する
print
このオプションを有効にすると、印刷用のユーティリティ クラスも@media print { ... }
生成され、メディア クエリ内でのみ適用されます。
$utilities: (
"opacity": (
property: opacity,
print: true,
values: (
0: 0,
25: .25,
50: .5,
75: .75,
100: 1,
)
)
);
出力:
.opacity-0 { opacity: 0 !important; }
.opacity-25 { opacity: .25 !important; }
.opacity-50 { opacity: .5 !important; }
.opacity-75 { opacity: .75 !important; }
.opacity-100 { opacity: 1 !important; }
@media print {
.opacity-print-0 { opacity: 0 !important; }
.opacity-print-25 { opacity: .25 !important; }
.opacity-print-50 { opacity: .5 !important; }
.opacity-print-75 { opacity: .75 !important; }
.opacity-print-100 { opacity: 1 !important; }
}
重要性
API によって生成されたすべてのユーティリティには、!important
意図したとおりにコンポーネントとモディファイア クラスを確実にオーバーライドするためのインクルードが含まれています。この設定は、$enable-important-utilities
変数を使用してグローバルに切り替えることができます (デフォルトはtrue
)。
API の使用
ユーティリティ API の仕組みを理解したところで、独自のカスタム クラスを追加し、デフォルト ユーティリティを変更する方法を学びましょう。
ユーティリティをオーバーライドする
同じキーを使用して既存のユーティリティをオーバーライドします。たとえば、追加のレスポンシブ オーバーフロー ユーティリティ クラスが必要な場合は、次のようにします。
$utilities: (
"overflow": (
responsive: true,
property: overflow,
values: visible hidden scroll auto,
),
);
ユーティリティを追加する
新しいユーティリティは$utilities
、map-merge
. 必要な Sass ファイル_utilities.scss
が最初にインポートされていることを確認してから、 を使用しmap-merge
て追加のユーティリティを追加します。たとえば、cursor
3 つの値を持つレスポンシブ ユーティリティを追加する方法を次に示します。
@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,
)
)
);
ユーティリティを変更する
および関数を使用して、デフォルト$utilities
マップ内の既存のユーティリティを変更します。以下の例では、ユーティリティに追加の値を追加しています。イニシャルから始めて、変更するユーティリティを指定します。そこから、ネストされたマップをフェッチして、ユーティリティのオプションと値にアクセスして変更します。map-get
map-merge
width
map-merge
"width"
map-get
@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%),
),
),
),
)
);
レスポンシブを有効にする
デフォルトでは現在レスポンシブではない既存の一連のユーティリティに対して、レスポンシブ クラスを有効にすることができます。たとえば、border
クラスをレスポンシブにするには、次のようにします。
@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 は次のようになります。
.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 { ... }
}
ユーティリティの名前を変更
v4 ユーティリティがないか、別の命名規則に慣れていますか? ユーティリティ API を使用してclass
、特定のユーティリティの結果をオーバーライドできます。たとえば、.ms-*
ユーティリティの名前を oldishに変更でき.ml-*
ます。
@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 ),
),
)
);
ユーティリティを削除する
グループキーを に設定して、デフォルトのユーティリティを削除しますnull
。たとえば、すべてのwidth
ユーティリティを削除するには、 を作成してその中$utilities
map-merge
に追加"width": null
します。
@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";
$utilities: map-merge(
$utilities,
(
"width": null
)
);
RTL のユーティリティを削除
アラビア語の改行など、一部の特殊なケースではRTL スタイリングが困難になります。rtl
したがって、オプションをfalse
次のように設定することで、RTL 出力からユーティリティを削除できます。
$utilities: (
"word-wrap": (
property: word-wrap word-break,
class: text,
values: (break: break-word),
rtl: false
),
);
出力:
/* rtl:begin:remove */
.text-break {
word-wrap: break-word !important;
word-break: break-word !important;
}
/* rtl:end:remove */
RTLCSSremove
コントロール ディレクティブのおかげで、これは RTL で何も出力しません。