Aqbeż għall-kontenut prinċipali Aqbeż għan-navigazzjoni tad-dokumenti
in English

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 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 nulltintuża bħala ċavetta tal-mappa, mhix ikkumpilata.
class Fakultattiv Varjabbli għall-isem tal-klassi jekk ma tridx li jkun l-istess bħall-proprjetà. F'każ li ma tipprovdix iċ- classċavetta u ċ- propertyċavetta hija firxa ta' kordi, l-isem tal-klassi jkun l-ewwel element tal- propertyfirxa.
state Fakultattiv Lista ta' varjanti ta' psewdo-klassi simili :hoverjew :focusli jiġġeneraw għall-utilità. L-ebda valur default.
responsive Fakultattiv Boolean li jindika jekk għandhomx jiġu ġġenerati klassijiet li jirrispondu. falseawtomatikament.
rfs Fakultattiv Boolean biex jippermetti l-iskala mill-ġdid tal-fluwidu. Agħti ħarsa lejn il- paġna tal- RFS biex issir taf kif jaħdem dan. falseawtomatikament.
print Fakultattiv Boolean li jindika jekk għandhomx jiġu ġġenerati klassijiet tal-istampar. falseawtomatikament.
rtl Fakultattiv Boolean li jindika jekk l-utilità għandhiex tinżamm f'RTL. trueawtomatikament.

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

Prefiss tal-klassi tad-dwana

Uża l- classgħażla biex tibdel il-prefiss tal-klassi użat fis-CSS ikkumpilat:

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

Output:

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

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

Utilitajiet li jirrispondu

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

Jinbidlu 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,
  ),
);

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.

Ż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/utilities";

$utilities: map-merge(
  $utilities,
  (
    "cursor": (
      property: cursor,
      class: cursor,
      responsive: true,
      values: auto pointer grab,
    )
  )
);

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/utilities";

$utilities: map-merge(
  $utilities,
  (
    "width": map-merge(
      map-get($utilities, "width"),
      (
        values: map-merge(
          map-get(map-get($utilities, "width"), "values"),
          (10: 10%),
        ),
      ),
    ),
  )
);

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/utilities";

$utilities: map-merge(
  $utilities, (
    "border": map-merge(
      map-get($utilities, "border"),
      ( responsive: true ),
    ),
  )
);

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/utilities";

$utilities: map-merge(
  $utilities, (
    "margin-start": map-merge(
      map-get($utilities, "margin-start"),
      ( class: ml ),
    ),
  )
);

Neħħi l-utilitajiet

Neħħi kwalunkwe mill-utilitajiet default billi tissettja ċ-ċavetta tal-grupp għal null. Per eżempju, biex tneħħi l- widthutilitajiet kollha tagħna, toħloq $utilities map-mergeu żid "width": nullfi ħdan.

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

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

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 .