實用程序 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 !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; }
}
更改實用程序
使用相同的密鑰覆蓋現有實用程序。例如,如果您想要其他響應式溢出實用程序類,您可以這樣做:
$utilities: (
"overflow": (
responsive: true,
property: overflow,
values: visible hidden scroll auto,
),
);
打印實用程序
啟用該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
帶有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 中輸出任何內容。