ยูทิลิตี้ 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
ตัวเลือกเพื่อระบุแมป Sass ที่จะสร้างตัวแปร CSS ภายในชุดกฎของคลาสยูทิลิตี้ โปรดทราบว่าอาจต้องมีการทำงานเพิ่มเติมเพื่อใช้ตัวแปร 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
ยูทิลิตี้ทั้งหมดของเรา ให้สร้าง a $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 */
สิ่งนี้ไม่ได้ส่งออกสิ่งใดใน RTL ต้องขอบคุณRTLCSS control remove
directive