उपयोगिता API

उपयोगिता एपीआई उपयोगिता वर्गहरू उत्पन्न गर्न Sass-आधारित उपकरण हो।

यस पृष्ठमा

बुटस्ट्र्याप उपयोगिताहरू हाम्रो उपयोगिता API मार्फत उत्पन्न हुन्छन् र Sass मार्फत उपयोगिता वर्गहरूको हाम्रो पूर्वनिर्धारित सेट परिमार्जन वा विस्तार गर्न प्रयोग गर्न सकिन्छ। हाम्रो उपयोगिता API Sass नक्सा र विभिन्न विकल्पहरु संग कक्षाहरु को परिवारहरु को लागी कार्यहरु को एक श्रृंखला मा आधारित छ। यदि तपाईं Sass नक्साहरूसँग अपरिचित हुनुहुन्छ भने, सुरु गर्न आधिकारिक Sass कागजातहरूमा पढ्नुहोस् ।

नक्साले हाम्रा सबै उपयोगिताहरू समावेश गर्दछ र यदि अवस्थित छ भने, पछि तपाईंको अनुकूलन नक्सासँग $utilitiesमर्ज गरिन्छ । $utilitiesउपयोगिता नक्साले निम्न विकल्पहरू स्वीकार गर्ने उपयोगिता समूहहरूको कुञ्जी सूची समावेश गर्दछ:

विकल्प	टाइप गर्नुहोस्	पूर्वनिर्धारित मान	विवरण
`property`	आवश्यक छ	-	सम्पत्तीको नाम, यो स्ट्रिङ वा स्ट्रिङको एर्रे (जस्तै, तेर्सो प्याडिङ वा मार्जिन) हुन सक्छ।
`values`	आवश्यक छ	-	मानहरूको सूची, वा यदि तपाईं कक्षाको नाम मान जस्तै होस् भन्ने चाहनुहुन्न भने नक्सा। यदि `null`नक्सा कुञ्जीको रूपमा प्रयोग गरिन्छ भने `class`, कक्षाको नाममा अघि बढाइएको छैन।
`class`	ऐच्छिक	खाली	उत्पन्न वर्गको नाम। यदि प्रदान गरिएको छैन र `property`स्ट्रिङको एरे हो भने, एरेको `class`पहिलो तत्वमा पूर्वनिर्धारित हुनेछ `property`। यदि प्रदान गरिएको छैन र `property`स्ट्रिङ हो भने, `values`कुञ्जीहरू `class`नामहरूको लागि प्रयोग गरिन्छ।
`css-var`	ऐच्छिक	`false`	CSS नियमहरूको सट्टा CSS चरहरू उत्पन्न गर्न बुलियन।
`css-variable-name`	ऐच्छिक	खाली	नियमसेट भित्र 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,
)

positionहाम्रो उपयोगिताहरूमा जस्तै, सूची वा नक्सा सेट गर्ने Sass चरको रूपमा :

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

यदि , प्रत्येक कुञ्जीका class: nullलागि कक्षाहरू उत्पन्न गर्छ :values

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

आउटपुट:

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

CSS चर उपयोगिताहरू

css-varबुलियन विकल्पमा सेट गर्नुहोस् र API ले सामान्य नियमहरूको trueसट्टा दिइएको चयनकर्ताको लागि स्थानीय CSS चरहरू उत्पन्न गर्नेछ । कक्षाको नाम भन्दा फरक CSS चल नाम सेट गर्न property: valueवैकल्पिक थप्नुहोस् ।css-variable-name

.text-opacity-*हाम्रो उपयोगिताहरू विचार गर्नुहोस् । यदि हामीले css-variable-nameविकल्प थप्यौं भने, हामीले अनुकूलन आउटपुट पाउनेछौं।

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

आउटपुट:

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

स्थानीय CSS चरहरू

Sass नक्सा निर्दिष्ट गर्न विकल्प प्रयोग गर्नुहोस् local-varsजसले उपयोगिता वर्गको नियमहरू भित्र स्थानीय 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। जब राज्यहरूको सूची प्रदान गरिन्छ, क्लासनामहरू त्यो छद्म-वर्गको लागि सिर्जना गरिन्छ। उदाहरणका लागि, होभरमा अस्पष्टता परिवर्तन गर्न, थप्नुहोस् र तपाइँ तपाइँको कम्पाइल गरिएको CSS मा state: hoverपाउनुहुनेछ ।.opacity-hover:hover

धेरै छद्म-कक्षाहरू चाहिन्छ? राज्यहरूको स्पेस-विभाजित सूची प्रयोग गर्नुहोस् 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; }
}

महत्व

एपीआई द्वारा उत्पन्न सबै उपयोगिताहरूमा !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/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";

उपयोगिताहरू परिमार्जन गर्नुहोस्

$utilitiesपूर्वनिर्धारित नक्सामा अवस्थित उपयोगिताहरू map-getर map-mergeकार्यहरू परिमार्जन गर्नुहोस्। तलको उदाहरणमा, हामी उपयोगिताहरूमा अतिरिक्त मान widthथप्दैछौं। प्रारम्भिकबाट सुरु गर्नुहोस् map-mergeर त्यसपछि कुन उपयोगितालाई परिमार्जन गर्न चाहनुहुन्छ निर्दिष्ट गर्नुहोस्। त्यहाँबाट, उपयोगिताका विकल्पहरू र मानहरू पहुँच गर्न र परिमार्जन गर्न नेस्टेड "width"नक्सा ल्याउनुहोस्।map-get

@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";

प्रतिक्रियाशील सक्षम गर्नुहोस्

तपाईंले हाल पूर्वनिर्धारित रूपमा उत्तरदायी नभएका उपयोगिताहरूको अवस्थित सेटका लागि उत्तरदायी कक्षाहरू सक्षम गर्न सक्नुहुन्छ। उदाहरणका लागि, borderकक्षाहरूलाई उत्तरदायी बनाउन:

@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";

यसले अब प्रत्येक ब्रेकपोइन्टको .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-*उपयोगिताहरूलाई पुरानोमा पुन: नामाकरण गर्न .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";

उपयोगिताहरू हटाउनुहोस्

map-remove()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";

तपाईले map-merge()Sass प्रकार्यnull प्रयोग गर्न सक्नुहुन्छ र उपयोगिता हटाउन समूह कुञ्जी सेट गर्न सक्नुहुन्छ।

@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";

थप्नुहोस्, हटाउनुहोस्, परिमार्जन गर्नुहोस्

map-merge()तपाईले Sass प्रकार्यको साथ एकै पटक धेरै उपयोगिताहरू थप्न, हटाउन र परिमार्जन गर्न सक्नुहुन्छ । यहाँ छ कि तपाइँ कसरी अघिल्लो उदाहरणहरू एक ठूलो नक्सामा संयोजन गर्न सक्नुहुन्छ।

@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";

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 removeनियन्त्रण निर्देशनलाई धन्यवाद ।