实用程序 API
实用程序 API 是一个基于 Sass 的工具,用于生成实用程序类。
Bootstrap 实用程序是使用我们的实用程序 API 生成的,可用于通过 Sass 修改或扩展我们的默认实用程序类集。我们的实用 API 基于一系列 Sass 映射和函数,用于生成具有各种选项的类族。如果您不熟悉 Sass 地图,请阅读官方 Sass 文档以开始使用。
该$utilities
地图包含我们所有的实用程序,稍后会与您的自定义$utilities
地图(如果存在)合并。实用程序映射包含实用程序组的键控列表,这些实用程序组接受以下选项:
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
property |
必需的 | – | 属性的名称,可以是字符串或字符串数组(例如,水平填充或边距)。 |
values |
必需的 | – | 值列表,如果您不希望类名与值相同,则为映射。如果null 用作映射键,则不编译。 |
class |
可选的 | 无效的 | 生成的类的名称。如果未提供并且property 是字符串数组,class 则默认为property 数组的第一个元素。 |
css-var |
可选的 | false |
用于生成 CSS 变量而不是 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; }
CSS 变量实用程序
将css-var
布尔选项设置为true
,API 将为给定的选择器生成本地 CSS 变量,而不是通常的property: value
规则。考虑我们的.text-opacity-*
实用程序:
$utilities: (
"text-opacity": (
css-var: true,
class: text-opacity,
values: (
25: .25,
50: .5,
75: .75,
100: 1
)
),
);
输出:
.text-opacity-25 { --bs-text-opacity: .25; }
.text-opacity-50 { --bs-text-opacity: .5; }
.text-opacity-75 { --bs-text-opacity: .75; }
.text-opacity-100 { --bs-text-opacity: 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/utilities";
$utilities: map-merge(
$utilities,
(
"cursor": (
property: cursor,
class: cursor,
responsive: true,
values: auto pointer grab,
)
)
);
修改实用程序
使用和函数修改默认$utilities
映射中的现有实用程序。在下面的示例中,我们为实用程序添加了一个附加值。从首字母开始,然后指定要修改的实用程序。从那里,获取嵌套映射以访问和修改实用程序的选项和值。map-get
map-merge
width
map-merge
"width"
map-get
@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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%),
),
),
),
)
);
启用响应式
您可以为默认情况下当前不响应的现有实用程序集启用响应类。例如,要使border
类响应:
@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";
$utilities: map-merge(
$utilities, (
"border": map-merge(
map-get($utilities, "border"),
( responsive: true ),
),
)
);
.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/utilities";
$utilities: map-merge(
$utilities, (
"margin-start": map-merge(
map-get($utilities, "margin-start"),
( class: ml ),
),
)
);
删除实用程序
通过将组键设置为 删除任何默认实用程序null
。例如,要删除我们所有的width
实用程序,请创建一个$utilities
map-merge
并"width": null
在其中添加。
@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/utilities";
$utilities: map-merge(
$utilities,
(
"width": null
)
);
删除 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 中输出任何内容。