l-1

WEB教程

主页/Bootstrap V5.3 中文手册/工具类库 Utilities/API 应用程序接口

Bootstrap V5.3 中文手册

API 应用程序接口

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

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

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

选择类型默认值描述
property必填–属性的名称，这可以是字符串或字符串数组（例如，水平填充或边距）。
values必填–值列表，或者映射（如果您不希望类名与值相同）。如果用作映射键，则不在类名前面。nullclass
class自选零生成的类的名称。如果未提供并且是字符串数组，则将默认为数组的第一个元素。如果未提供并且是字符串，则键用于名称。propertyclasspropertypropertyvaluesclass
css-var自选falseBoolean 生成 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; }

财产

必须为任何实用程序设置所需的键，并且它必须包含有效的 CSS 属性。此属性用于生成的实用程序的规则集中。当省略键时，它也用作默认类名。考虑实用程序：propertyclasstext-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; }

值

使用键指定应在生成的类名和规则中使用指定的值。可以是列表或地图（在实用程序或 Sass 变量中设置）。valuesproperty

作为列表，就像文本装饰实用程序一样：

values: none underline line-through

作为地图，就像不透明度实用程序一样：

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

作为设置列表或地图的 Sass 变量，如我们的 position utilities 中：

values: $position-values

类

使用该选项更改编译的 CSS 中使用的类前缀。例如，要从 更改为 ：class.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: nullvalues

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

输出：

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

CSS 变量实用程序

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

考虑一下我们的公用事业。如果我们添加该选项，我们将获得自定义输出。.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 变量

使用该选项指定一个 Sass 映射，该映射将在实用程序类的规则集中生成本地 CSS 变量。请注意，在生成的 CSS 规则中使用这些本地 CSS 变量可能需要额外的工作。例如，考虑我们的实用程序：local-vars.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;
}

国家

使用该选项生成伪类变体。伪类的示例是 和 。当提供状态列表时，将为该伪类创建类名。例如，要更改悬停时的不透明度，请添加，您将进入编译后的 CSS。state:hover:focusstate: hover.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-utilitiestrue

使用 API

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

覆盖实用程序

使用相同的密钥覆盖现有实用程序。例如，如果您想要其他响应式溢出实用程序类，您可以执行以下作：

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

添加实用程序

可以使用 将新实用程序添加到默认地图中。确保我们需要的 Sass 文件并首先导入，然后使用 添加您的其他实用程序。例如，下面介绍如何添加具有三个值的响应式实用程序。$utilitiesmap-merge_utilities.scssmap-mergecursor

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

修改实用程序

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

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

现在，这将为每个断点生成 和 的响应式变体。您生成的 CSS 将如下所示：.border.border-0

.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 可用于覆盖给定实用程序的结果，例如，将实用程序重命名为 oldish：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 样式变得困难，例如阿拉伯语中的换行符。因此，可以通过将选项设置为：rtlfalse

$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 删除控制指令。

声明：该Bootstrap v5.3 内容来自Bootstrap v5.3官方网站；中文翻译是使用Microsoft Edge浏览器免费翻译而来，且部分存在结合了Deepseek及人工翻译。