Utility 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 变量中设置）。

As a list, like with text-decoration utilities:

values: none underline line-through

作为映射，就像 opacity utilities：

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

作为设置列表或映射的 Sass 变量，如我们的 position utilities：

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选项指定一个 Sass 映射，该映射将在实用程序类的规则集中生成局部 CSS 变量。请注意，在生成的 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添加其他实用程序。例如，下面介绍如何添加具有三个值的响应式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 函数一次添加、删除和修改许多实用程序。下面介绍如何将前面的示例合并到一个更大的映射中。

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

这不会在 RTL 中输出任何内容，这要归功于 RTLCSS remove控制指令。