ユーティリティAPI

ユーティリティAPIは、ユーティリティクラスを生成するためのSassベースのツールです。

このページの内容

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

$utilitiesマップには、すべてのユーティリティが含まれており、後で存在する場合はカスタム$utilitiesマップとマージされます。ユーティリティマップには、次のオプションを受け入れるユーティリティグループのキー付きリストが含まれています。

オプション	タイプ	デフォルト値	説明
`property`	必須	–	プロパティの名前。文字列または文字列の配列にすることができます（例：水平方向のパディングまたはマージン）。
`values`	必須	–	値のリスト、またはクラス名を値と同じにしない場合のマップ。マップキーとして`null`を使用すると、クラス名に`class`は追加されません。
`class`	オプション	null	生成されたクラスの名前。指定されていない場合、`property`が文字列の配列であれば、`class`は`property`配列の最初の要素になります。指定されていない場合、`property`が文字列であれば、`values`キーが`class`名として使用されます。
`css-var`	オプション	`false`	CSSルールではなくCSS変数を生成するかどうかを示すブール値。
`css-variable-name`	オプション	null	ルールセット内のCSS変数のカスタムプレフィックスなしの名前。
`local-vars`	オプション	null	CSSルールに加えて生成するローカルCSS変数のマップ。
`state`	オプション	null	生成する擬似クラスのバリアントのリスト（例：`：hover`または`：focus`）。
`responsive`	オプション	`false`	レスポンシブなクラスを生成するかどうかを示すブール値。
`rfs`	オプション	`false`	RFSを使用した流動的なリサイズを有効にするためのブール値。
`print`	オプション	`false`	印刷クラスを生成する必要があるかどうかを示すブール値。
`rtl`	オプション	`true`	RTLでユーティリティを保持する必要があるかどうかを示すブール値。

APIの説明

すべてのユーティリティ変数は、私たちの`_utilities.scss`スタイルシート内の`$utilities`変数に追加されます。ユーティリティの各グループは、次のようなものです。

$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`ユーティリティのように。

values: none underline line-through

マップとして、`opacity`ユーティリティのように。

values: (
  0: 0,
  25: .25,
  50: .5,
  75: .75,
  100: 1,
)

リストまたはマップを設定するSass変数として、当社の`position`ユーティリティのように。

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; }

`class: null`の場合、`values`キーごとにクラスを生成します。

$utilities: (
  "visibility": (
    property: visibility,
    class: null,
    values: (
      visible: visible,
      invisible: hidden,
    )
  )
);

出力

.visible { visibility: visible !important; }
.invisible { visibility: hidden !important; }

CSS変数ユーティリティ

`css-var`ブールオプションを`true`に設定すると、APIは通常の`property: value`ルールではなく、指定されたセレクターに対してローカルCSS変数を生成します。オプションの`css-variable-name`を追加して、クラス名とは異なるCSS変数名を設定します。

当社の`.text-opacity-*`ユーティリティを考えてみましょう。`css-variable-name`オプションを追加すると、カスタム出力が得られます。

$utilities: (
  "text-opacity": (
    css-var: true,
    css-variable-name: text-alpha,
    class: text-opacity,
    values: (
      25: .25,
      50: .5,
      75: .75,
      100: 1
    )
  ),
);

出力

.text-opacity-25 { --bs-text-alpha: .25; }
.text-opacity-50 { --bs-text-alpha: .5; }
.text-opacity-75 { --bs-text-alpha: .75; }
.text-opacity-100 { --bs-text-alpha: 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`があります。状態のリストが提供されると、その擬似クラスのクラス名が作成されます。たとえば、ホバー時に不透明度を変更するには、`state: hover`を追加すると、コンパイルされたCSSに`.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,
  ),
);

ユーティリティの追加

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

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

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

@import "bootstrap/scss/utilities/api";

ユーティリティの変更

`map-get`関数と`map-merge`関数を使用して、デフォルトの`$utilities`マップ内の既存のユーティリティを変更します。次の例では、`width`ユーティリティに追加の値を追加しています。最初に`map-merge`で開始し、変更するユーティリティを指定します。そこから、`map-get`を使用してネストされた`"width"`マップを取得し、ユーティリティのオプションと値にアクセスして変更します。

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@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%),
        ),
      ),
    ),
  )
);

@import "bootstrap/scss/utilities/api";

レスポンシブの有効化

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

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

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

@import "bootstrap/scss/utilities/api";

これにより、各ブレークポイントに対して.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-*ユーティリティを古い.ml-*に名前変更するには

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

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

@import "bootstrap/scss/utilities/api";

ユーティリティの削除

map-remove() Sass関数を使用して、デフォルトのユーティリティを削除できます。

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

// Remove multiple utilities with a comma-separated list
$utilities: map-remove($utilities, "width", "float");

@import "bootstrap/scss/utilities/api";

map-merge() Sass関数を使用し、グループキーをnullに設定して、ユーティリティを削除することもできます。

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

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

@import "bootstrap/scss/utilities/api";

追加、削除、変更

map-merge() Sass関数を使用して、複数のユーティリティを一括で追加、削除、変更できます。前の例を1つの大きなマップに組み合わせる方法を次に示します。

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/variables-dark";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
  $utilities,
  (
    // Remove the `width` utility
    "width": null,

    // Make an existing utility responsive
    "border": map-merge(
      map-get($utilities, "border"),
      ( responsive: true ),
    ),

    // Add new utilities
    "cursor": (
      property: cursor,
      class: cursor,
      responsive: true,
      values: auto pointer grab,
    )
  )
);

@import "bootstrap/scss/utilities/api";

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 */

RTLCSSのremove制御ディレクティブのおかげで、RTLでは何も出力されません。