Utility API

utility API是一个基于Sass的工具，用于生成utility类。

On this page

Bootstrap utility是通过我们的utility API生成的，可用于通过Sass修改或扩展我们的默认utility类集。我们的utilityAPI基于一系列Sass Map和函数，用于生成具有各种选项的类族。如果你不熟悉Sass地图，请阅读官方Sass文档开始。

$utilities map 包含我们所有的utility，稍后将与你的自定义$utility map(如果存在)合并。 utility map 包含接受以下选项的utility组的键控列表：

Option	Type	Default value	Description
`property`	Required	–	属性的名称，可以是字符串或字符串数组(例如，horizontal paddings 或 margins)。
`values`	Required	–	值的列表，如果不希望类名与值相同，则应为Map。如果`null`用作Map键，则`class`不在类名前加前缀。
`class`	Optional	null	生成的类的名称。如果未提供，且`property`是字符串数组，则`class`将默认为`property`数组的第一个元素。如果没有提供，并且`property`是一个字符串，则`values`键用于`class`名称。
`css-var`	Optional	`false`	用于生成CSS变量而不是CSS规则的布尔值。
`css-variable-name`	Optional	null	规则集中CSS变量的自定义无前缀名称。
`local-vars`	Optional	null	除了生成CSS规则之外，还要生成本地CSS变量的Map。
`state`	Optional	null	要生成的伪类变体（例如，`:hover` 或 `:focus`）的列表。
`responsive`	Optional	`false`	指示是否应生成响应式类的布尔值。
`rfs`	Optional	`false`	布尔值可启用fluid rescaling with RFS。
`print`	Optional	`false`	指示是否需要生成打印类的布尔值。
`rtl`	Optional	`true`	布尔值，指示utility是否应保留在RTL中。

API解释

所有utility变量都添加到 _utilities.scss 样式表中的$utilities变量中。每组utility看起来如下所示：

$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

必须为任何utility设置所需的property键，并且该键必须包含有效的CSS属性。此属性用于生成的utility的规则集中。如果省略了class键，它也将用作默认类名。参考 text-decoration utility：

$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

使用values键可以指定指定的property的哪些值应在生成的类名和规则中使用。可以是list(列表)或map（在utility或Sass变量中设置）。

作为一个列表，例如text-decoration utility：

values: none underline line-through

作为一个Map，例如``opacity` utilities：

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

使用list或map集合的Sass变量，如在我们的position utilities中：

values: $position-values

Class

使用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变量utility

将css-var布尔选项设置为true，API将为给定的选择器生成本地css变量，而不是通常的property:value规则。添加可选的css-variable-name以设置与类名不同的css变量名。

参考我们的 .text-opacity-* utility。如果我们添加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 Map，该 Map将在utility类的规则集中生成本地CSS变量。 请注意，在生成的CSS规则中使用那些本地CSS变量可能需要额外的工作。例如，参考我们的.bg-*`utility：

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

States

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

响应式

添加responsible布尔值以在所有断点上生成响应式utility(例如，.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选项还会生成打印的utility类，这些类仅应用于@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生成的所有utility都包括 !important 以确保它们按预期覆盖组件和修饰符类。你可以使用$enable-important-utilities变量全局切换此设置(默认为true)。

使用API

既然你已经熟悉了utility API的工作原理，请学习如何添加自己的自定义类并修改我们的默认utility。

重写utility

使用相同的键覆盖现有utility。例如，如果你想要其他响应式 overflow utility类，可以执行以下操作：

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

添加utility

可以通过map-merge将新的utility添加到默认的$utilities Map中。请确保先导入我们所需的Sass文件和_utilities.scss，然后使用map-merge添加其他utility。例如，以下是如何添加具有三个值的响应式 cursor utility。

@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";

修改utility

使用map-get和map-merge函数修改默认$utilities Map中的现有utility。在下面的示例中，我们将向 width utility添加一个附加值。从初始的map-merge开始，然后指定要修改的utility。从那里，使用map-get获取嵌套的"width" Map，以访问和修改utility的选项和值。

@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";

启用响应式

你可以为当前默认情况下没有响应式的现有utility 集合用响应式类。例如，要使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 { ... }
}

重命名utility

缺少v4 中的utility，或者习惯于其他命名约定？ utility API可用于覆盖给定utility的结果class。例如，将.ms-*utility重命名为老式的.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";

删除utility

使用map-remove() Sass function删除任何默认utility。

@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函数并将分组key设置为null以删除该utility。

@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函数同时添加、删除和修改许多utility。以下是如何将前面的示例组合到一个更大的Map中。

@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中的utility

某些edge场景使RTL造型变得困难，例如阿拉伯语中的换行符。因此，通过将RTL选项设置为false，可以从RTL输出中删除utility：

$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 control指令]，这不会在RTL中输出任何内容(https://rtlcss.com/learn/usage-guide/control-directives/#remove).