實用程序 API

實用程序 API 是一個基於 Sass 的工具，用於生成實用程序類。

在本頁面

Bootstrap 實用程序是使用我們的實用程序 API 生成的，可用於通過 Sass 修改或擴展我們的默認實用程序類集。我們的實用 API 基於一系列 Sass 映射和函數，用於生成具有各種選項的類族。如果您不熟悉 Sass 地圖，請閱讀官方 Sass 文檔以開始使用。

該$utilities地圖包含我們所有的實用程序，稍後會與您的自定義$utilities地圖（如果存在）合併。實用程序映射包含實用程序組的鍵控列表，這些實用程序組接受以下選項：

選項	類型	默認值	描述
`property`	必需的	–	屬性的名稱，可以是字符串或字符串數組（例如，水平填充或邊距）。
`values`	必需的	–	值列表，如果您不希望類名與值相同，則為映射。如果`null`用作映射鍵，`class`則不附加到類名。
`class`	可選的	無效的	生成的類的名稱。如果未提供並且`property`是字符串數組，`class`則默認為`property`數組的第一個元素。如果未提供並且`property`是字符串，則`values`鍵用於`class`名稱。
`css-var`	可選的	`false`	用於生成 CSS 變量而不是 CSS 規則的布爾值。
`css-variable-name`	可選的	無效的	規則集中 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實用程序一樣：

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 將為給定的選擇器生成本地 CSS 變量，而不是通常的property: value規則。添加一個可選項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並且您將獲得已.opacity-hover:hover編譯的 CSS。

需要多個偽類？使用空格分隔的狀態列表：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具有三個值的響應式實用程序。

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

修改實用程序

使用和函數修改默認$utilities映射中的現有實用程序。在下面的示例中，我們為實用程序添加了一個附加值。從首字母開始，然後指定要修改的實用程序。從那裡，獲取嵌套映射以訪問和修改實用程序的選項和值。map-getmap-mergewidthmap-merge"width"map-get

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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/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-*實用程序重命名為 oldish .ml-*：

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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/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/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

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

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

添加、刪除、修改

map-merge()您可以使用Sass 函數一次添加、刪除和修改許多實用程序。以下是如何將前面的示例組合成一張更大的地圖。

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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因此，可以通過將選項設置為：從 RTL 輸出中刪除實用程序false：

$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 中輸出任何內容。