Utilità API

L-API ta 'utilità hija għodda bbażata fuq Sass biex tiġġenera klassijiet ta' utilità.

Fuq din il-paġna

L-utilitajiet Bootstrap huma ġġenerati bl-API ta 'utilità tagħna u jistgħu jintużaw biex jimmodifikaw jew jestendu s-sett default tagħna ta' klassijiet ta 'utilità permezz ta' Sass. L-API ta 'utilità tagħna hija bbażata fuq serje ta' mapep u funzjonijiet Sass għall-ġenerazzjoni ta 'familji ta' klassijiet b'għażliet varji. Jekk m'intix familjari mal-mapep Sass, aqra fuq id -dokumenti uffiċjali Sass biex tibda.

Il- $utilitiesmappa fiha l-utilitajiet kollha tagħna u aktar tard hija magħquda mal- $utilitiesmappa tad-dwana tiegħek, jekk preżenti. Il-mappa ta’ utilità fiha lista ta’ gruppi ta’ utilità li jaċċettaw l-għażliet li ġejjin:

Għażla	Tip	Valur default	Deskrizzjoni
`property`	Meħtieġ	–	Isem tal-proprjetà, dan jista 'jkun spag jew firxa ta' spag (eż., paddings orizzontali jew marġini).
`values`	Meħtieġ	–	Lista ta' valuri, jew mappa jekk ma tridx li l-isem tal-klassi jkun l-istess bħall-valur. Jekk `null`jintuża bħala ċavetta tal-mappa, `class`ma jiġix miżjud mal-isem tal-klassi.
`class`	Fakultattiv	null	Isem tal-klassi ġġenerata. Jekk mhux ipprovdut u `property`huwa firxa ta 'kordi, `class`se default għall-ewwel element tal- `property`firxa. Jekk mhux ipprovdut u `property`huwa string, iċ- `values`ċwievet jintużaw għall- `class`ismijiet.
`css-var`	Fakultattiv	`false`	Boolean biex jiġġenera varjabbli CSS minflok regoli CSS.
`css-variable-name`	Fakultattiv	null	Isem personalizzat mhux prefissat għall-varjabbli CSS ġewwa r-regoli.
`local-vars`	Fakultattiv	null	Mappa tal-varjabbli tas-CSS lokali biex tiġġenera flimkien mar-regoli tas-CSS.
`state`	Fakultattiv	null	Lista ta' varjanti ta' psewdo-klassi (eż., `:hover`jew `:focus`) biex tiġġenera.
`responsive`	Fakultattiv	`false`	Boolean li jindika jekk għandhomx jiġu ġġenerati klassijiet li jirrispondu.
`rfs`	Fakultattiv	`false`	Boolean biex jippermetti l -iskala mill-ġdid tal-fluwidu bl-RFS .
`print`	Fakultattiv	`false`	Boolean li jindika jekk għandhomx jiġu ġġenerati klassijiet tal-istampar.
`rtl`	Fakultattiv	`true`	Boolean li jindika jekk l-utilità għandhiex tinżamm f'RTL.

API spjegat

Il-varjabbli kollha tal-utilità huma miżjuda mal- $utilitiesvarjabbli fi ħdan il- folja tal- _utilities.scssistil tagħna. Kull grupp ta 'utilitajiet jidher xi ħaġa bħal din:

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

Li joħroġ dan li ġej:

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

Proprjetà

Iċ- propertyċavetta meħtieġa għandha tkun issettjata għal kwalunkwe utilità, u għandu jkun fiha proprjetà CSS valida. Din il-proprjetà tintuża fis-sett ta' regoli tal-utilità ġġenerata. Meta ċ- classċavetta titħalla barra, isservi wkoll bħala l-isem tal-klassi default. Ikkunsidra l- text-decorationutilità:

$utilities: (
  "text-decoration": (
    property: text-decoration,
    values: none underline line-through
  )
);

Output:

.text-decoration-none { text-decoration: none !important; }
.text-decoration-underline { text-decoration: underline !important; }
.text-decoration-line-through { text-decoration: line-through !important; }

Valuri

Uża ċ- valuesċavetta biex tispeċifika liema valuri għal dak speċifikat propertygħandhom jintużaw fl-ismijiet u r-regoli tal-klassi ġġenerati. Jista 'jkun lista jew mappa (settjat fl-utilitajiet jew f'varjabbli Sass).

Bħala lista, bħall- text-decorationutilitajiet :

values: none underline line-through

Bħala mappa, bħall- opacityutilitajiet :

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

Bħala varjabbli Sass li tistabbilixxi l-lista jew il-mappa, bħal fl- positionutilitajiet tagħna :

values: $position-values

Klassi

Uża l- classgħażla biex tibdel il-prefiss tal-klassi użat fis-CSS ikkumpilat. Per eżempju, biex tinbidel minn .opacity-*għal .o-*:

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

Output:

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

Jekk class: null, jiġġenera klassijiet għal kull valuesċwievet:

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

Output:

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

CSS utilitajiet varjabbli

Issettja l- css-vargħażla booleana għal trueu l-API se tiġġenera varjabbli CSS lokali għas-selettur partikolari minflok ir- property: valueregoli tas-soltu. Żid fakultattiv css-variable-namebiex tissettja isem varjabbli CSS differenti mill-isem tal-klassi.

Ikkunsidra l- .text-opacity-*utilitajiet tagħna. Jekk inżidu l- css-variable-namegħażla, aħna ser tikseb output personalizzat.

$utilities: (
  "text-opacity": (
    css-var: true,
    css-variable-name: text-alpha,
    class: text-opacity,
    values: (
      25: .25,
      50: .5,
      75: .75,
      100: 1
    )
  ),
);

Output:

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

Varjabbli CSS lokali

Uża l- local-varsgħażla biex tispeċifika mappa Sass li tiġġenera varjabbli CSS lokali fi ħdan is-sett ta' regoli tal-klassi ta' utilità. Jekk jogħġbok innota li jista 'jeħtieġ xogħol addizzjonali biex tikkonsma dawk il-varjabbli CSS lokali fir-regoli CSS iġġenerati. Pereżempju, ikkunsidra l- .bg-*utilitajiet tagħna:

$utilities: (
  "background-color": (
    property: background-color,
    class: bg,
    local-vars: (
      "bg-opacity": 1
    ),
    values: map-merge(
      $utilities-bg-colors,
      (
        "transparent": transparent
      )
    )
  )
);

Output:

.bg-primary {
  --bs-bg-opacity: 1;
  background-color: rgba(var(--bs-primary-rgb), var(--bs-bg-opacity)) !important;
}

l-Istati

Uża l- stategħażla biex tiġġenera varjazzjonijiet tal-psewdo-klassi. Eżempju psewdo-klassijiet huma :hoveru :focus. Meta tiġi pprovduta lista ta' stati, jinħolqu ismijiet tal-klassi għal dik il-psewdo-klassi. Per eżempju, biex tibdel l-opaċità fuq il-passaġġ, żid state: hoveru ikollok .opacity-hover:hoverfis-CSS ikkumpilat tiegħek.

Għandek bżonn psewdo-klassijiet multipli? Uża lista ta' stati separati bi spazju: state: hover focus.

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

Output:

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

Jirrispondi

Żid il- responsiveboolean biex tiġġenera utilitajiet li jirrispondu (eż, .opacity-md-25) fil -punti ta' waqfien kollha .

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

Output:

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

Stampa

L-abilitazzjoni tal- printgħażla tiġġenera wkoll klassijiet ta' utilità għall-istampar, li huma applikati biss fi ħdan il @media print { ... }-mistoqsija tal-midja.

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

Output:

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

Importanza

L-utilitajiet kollha ġġenerati mill-API jinkludu !importantbiex jiżguraw li jegħlbu l-komponenti u l-klassijiet tal-modifikaturi kif maħsub. Tista' taqleb dan is-setting globalment mal- $enable-important-utilitiesvarjabbli (defaults għal true).

Bl-użu tal-API

Issa li int familjari ma' kif taħdem l-API tal-utilitajiet, titgħallem kif iżżid il-klassijiet tad-dwana tiegħek stess u timmodifika l-utilitajiet default tagħna.

Ikkalkola l-utilitajiet

Ibdel l-utilitajiet eżistenti billi tuża l-istess ċavetta. Pereżempju, jekk trid klassijiet ta' utilità ta' overflow addizzjonali li jirrispondu, tista' tagħmel dan:

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

Żid l-utilitajiet

Utilitajiet ġodda jistgħu jiġu miżjuda mal- $utilitiesmappa default b' map-merge. Kun żgur li l-fajls Sass meħtieġa tagħna u _utilities.scsshuma importati l-ewwel, imbagħad uża l- map-mergebiex iżżid l-utilitajiet addizzjonali tiegħek. Pereżempju, hawn kif iżżid cursorutilità li tirreaġixxi bi tliet valuri.

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

Immodifika l-utilitajiet

Immodifika l-utilitajiet eżistenti fil- $utilitiesmappa default bi map-getu map-mergefunzjonijiet. Fl-eżempju hawn taħt, qed inżidu valur addizzjonali għall- widthutilitajiet. Ibda b'inizjali map-mergeu mbagħad speċifika liema utilità trid timmodifika. "width"Minn hemm, ġib il- mappa nested map-getbiex taċċessa u timmodifika l-għażliet u l-valuri tal-utilità.

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

Ippermetti responsive

Tista' tattiva klassijiet li jirrispondu għal sett eżistenti ta' utilitajiet li bħalissa mhumiex reattivi b'mod awtomatiku. Pereżempju, biex il- borderklassijiet jirreaġixxu:

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

Dan issa se jiġġenera varjazzjonijiet reattivi ta ' .borderu .border-0għal kull breakpoint. Is-CSS iġġenerat tiegħek se jidher bħal dan:

.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 { ... }
}

Semmi mill-ġdid l-utilitajiet

Utilitajiet v4 nieqsa, jew użati għal konvenzjoni oħra ta' ismijiet? L-API tal-utilitajiet tista' tintuża biex tegħleb ir-riżultat classta' utilità partikolari—per eżempju, biex tibdel l -isem .ms-*tal-utilitajiet għal oldish .ml-*:

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

Neħħi l-utilitajiet

Neħħi kwalunkwe mill-utilitajiet default bil- map-remove()funzjoni Sass .

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

Tista 'wkoll tuża l- map-merge()funzjoni Sass u ssettja ċ-ċavetta tal-grupp nullbiex tneħħi l-utilità.

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@import "bootstrap/scss/maps";
@import "bootstrap/scss/mixins";
@import "bootstrap/scss/utilities";

$utilities: map-merge(
  $utilities,
  (
    "width": null
  )
);

@import "bootstrap/scss/utilities/api";

Żid, neħħi, immodifika

Tista 'żżid, tneħħi, u timmodifika ħafna utilitajiet kollha f'daqqa bil- map-merge()funzjoni Sass . Hawn kif tista 'tgħaqqad l-eżempji preċedenti f'mappa waħda akbar.

@import "bootstrap/scss/functions";
@import "bootstrap/scss/variables";
@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";

Neħħi l-utilità f'RTL

Xi każijiet tat-tarf jagħmlu l -istil RTL diffiċli , bħal waqfiet tal-linji bl-Għarbi. Għalhekk l-utilitajiet jistgħu jitneħħew mill-output RTL billi tissettja l- rtlgħażla għal false:

$utilities: (
  "word-wrap": (
    property: word-wrap word-break,
    class: text,
    values: (break: break-word),
    rtl: false
  ),
);

Output:

/* rtl:begin:remove */
.text-break {
  word-wrap: break-word !important;
  word-break: break-word !important;
}
/* rtl:end:remove */

Dan ma joħroġ xejn f'RTL, grazzi għad -direttiva tal- kontroll RTLCSSremove .