实用程序API

实用程序API是用于生成实用程序类的基于Sass的工具。

在本页面

Bootstrap 实用程序是用我们的实用程序API生成的，可以通过Sass修改或扩展我们的默认实用程序类集。我们的实用API基于一系列Sass映射和函数，用于生成具有各种选项的类族。如果您不熟悉Sass映射，请阅读Sass官方文档开始使用。

$utilities映射包含我们的所有实用程序，稍后将与您的自定义 $utilities 映射（如果存在）合并。实用程序映射包含接受以下选项的实用程序组的键控列表：

选项	类型	描述
`property`	必须	属性的名称，可以是字符串或字符串数组（例如，水平填充或边距）。
`values`	必须	值的列表，如果不希望类名与值相同，则使用映射。如果将 `null`用作映射键，则不会编译它。
`class`	可选	如果不希望类名与属性相同，则为该类名指定一个变量。如果不提供`class` 键，而 `property`键是字符串数组，则类名将是`property`数组的第一个元素。
`state`	可选	为实用程序生成的伪类变量列表，如 `:hover` 或 `:focus` 。没有默认值。
`responsive`	可选	布尔值，指示是否需要生成响应类。默认为 `false`。
`rfs`	可选	布尔值以启用流体重缩放。查看RFS页面以了解其工作原理。默认为 `false`。
`print`	可选	布尔值，指示是否需要生成打印类。默认为`false`。
`rtl`	可选	布尔值，指示实用程序是否应保留在RTL中。默认情况下为 `true`。

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

自定义类前缀

使用 class 选项更改已编译CSS中使用的类前缀：

$utilities: (
  "opacity": (
    property: opacity,
    class: o,
    values: (
      0: 0,
      25: .25,
      50: .5,
      75: .75,
      100: 1,
    )
  )
 );

输出：

.o-0 { opacity: 0; }
.o-25 { opacity: .25; }
.o-50 { opacity: .5; }
.o-75 { opacity: .75; }
.o-100 { opacity: 1; }

状态

使用 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; }
.opacity-25-hover:hover { opacity: .25; }
.opacity-50-hover:hover { opacity: .5; }
.opacity-75-hover:hover { opacity: .75; }
.opacity-100-hover:hover { opacity: 1; }

响应实用程序

添加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; }
.opacity-25 { opacity: .25; }
.opacity-50 { opacity: .5; }
.opacity-75 { opacity: .75; }
.opacity-100 { opacity: 1; }

@media (min-width: 576px) {
  .opacity-sm-0 { opacity: 0; }
  .opacity-sm-25 { opacity: .25; }
  .opacity-sm-50 { opacity: .5; }
  .opacity-sm-75 { opacity: .75; }
  .opacity-sm-100 { opacity: 1; }
}

@media (min-width: 768px) {
  .opacity-md-0 { opacity: 0; }
  .opacity-md-25 { opacity: .25; }
  .opacity-md-50 { opacity: .5; }
  .opacity-md-75 { opacity: .75; }
  .opacity-md-100 { opacity: 1; }
}

@media (min-width: 992px) {
  .opacity-lg-0 { opacity: 0; }
  .opacity-lg-25 { opacity: .25; }
  .opacity-lg-50 { opacity: .5; }
  .opacity-lg-75 { opacity: .75; }
  .opacity-lg-100 { opacity: 1; }
}

@media (min-width: 1200px) {
  .opacity-xl-0 { opacity: 0; }
  .opacity-xl-25 { opacity: .25; }
  .opacity-xl-50 { opacity: .5; }
  .opacity-xl-75 { opacity: .75; }
  .opacity-xl-100 { opacity: 1; }
}

@media (min-width: 1400px) {
  .opacity-xxl-0 { opacity: 0; }
  .opacity-xxl-25 { opacity: .25; }
  .opacity-xxl-50 { opacity: .5; }
  .opacity-xxl-75 { opacity: .75; }
  .opacity-xxl-100 { opacity: 1; }
}

改变实用程序

使用相同的键重写现有的实用程序。例如，如果需要其他响应溢出实用程序类，可以执行以下操作：

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

打印实用程序

启用 print 选项还将为 print生成实用程序类，这些实用程序类仅应用于 @media print { ... } 媒体查询。

$utilities: (
  "opacity": (
    property: opacity,
    print: true,
    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; }

@media print {
  .opacity-print-0 { opacity: 0; }
  .opacity-print-25 { opacity: .25; }
  .opacity-print-50 { opacity: .5; }
  .opacity-print-75 { opacity: .75; }
  .opacity-print-100 { opacity: 1; }
}

使用API

现在您已经熟悉了实用程序API的工作原理，了解如何添加您自己的自定义类并修改我们的默认实用程序。

添加实用程序

可以使用 map-merge将新工具添加到默认的 $utilities映射中。确保我们的 _utilities.scss 首先导入，然后使用 map-merge添加其他实用程序。例如，下面介绍如何添加具有三个值的cursor 实用程序。

@import "bootstrap/scss/utilities";

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

修改实用程序

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

@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%),
        ),
      ),
    ),
  )
);

删除实用程序

通过将组键设置为null删除任何默认实用程序。例如，要删除所有 width实用程序，请创建 $utilities map-merge 并在其中添加 "width": null。

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

由于 RTLCSS remove control指令，这不会在RTL中输出任何内容。