You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/utilities/api.md
+42-42Lines changed: 42 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -387,11 +387,11 @@ $utilities: (
387
387
New utilities can be added to the default `$utilities` map with a `map-merge`. Make sure our required Sass files and `_utilities.scss` are imported first, then use the `map-merge` to add your additional utilities. For example, here's how to add a responsive `cursor` utility with three values.
388
388
389
389
```scss
390
-
@import"bootstrap/scss/functions";
391
-
@import"bootstrap/scss/variables";
392
-
@import"bootstrap/scss/maps";
393
-
@import"bootstrap/scss/mixins";
394
-
@import"bootstrap/scss/utilities";
390
+
@import"@coreui/coreui/scss/functions";
391
+
@import"@coreui/coreui/scss/variables";
392
+
@import"@coreui/coreui/scss/maps";
393
+
@import"@coreui/coreui/scss/mixins";
394
+
@import"@coreui/coreui/scss/utilities";
395
395
396
396
$utilities: map-merge(
397
397
$utilities,
@@ -405,19 +405,19 @@ $utilities: map-merge(
405
405
)
406
406
);
407
407
408
-
@import"bootstrap/scss/utilities/api";
408
+
@import"@coreui/coreui/scss/utilities/api";
409
409
```
410
410
411
411
### Modify utilities
412
412
413
413
Modify existing utilities in the default `$utilities` map with `map-get` and `map-merge` functions. In the example below, we're adding an additional value to the `width` utilities. Start with an initial `map-merge` and then specify which utility you want to modify. From there, fetch the nested `"width"` map with `map-get` to access and modify the utility's options and values.
414
414
415
415
```scss
416
-
@import"bootstrap/scss/functions";
417
-
@import"bootstrap/scss/variables";
418
-
@import"bootstrap/scss/maps";
419
-
@import"bootstrap/scss/mixins";
420
-
@import"bootstrap/scss/utilities";
416
+
@import"@coreui/coreui/scss/functions";
417
+
@import"@coreui/coreui/scss/variables";
418
+
@import"@coreui/coreui/scss/maps";
419
+
@import"@coreui/coreui/scss/mixins";
420
+
@import"@coreui/coreui/scss/utilities";
421
421
422
422
$utilities: map-merge(
423
423
$utilities,
@@ -434,19 +434,19 @@ $utilities: map-merge(
434
434
)
435
435
);
436
436
437
-
@import"bootstrap/scss/utilities/api";
437
+
@import"@coreui/coreui/scss/utilities/api";
438
438
```
439
439
440
440
#### Enable responsive
441
441
442
442
You can enable responsive classes for an existing set of utilities that are not currently responsive by default. For example, to make the `border` classes responsive:
443
443
444
444
```scss
445
-
@import"bootstrap/scss/functions";
446
-
@import"bootstrap/scss/variables";
447
-
@import"bootstrap/scss/maps";
448
-
@import"bootstrap/scss/mixins";
449
-
@import"bootstrap/scss/utilities";
445
+
@import"@coreui/coreui/scss/functions";
446
+
@import"@coreui/coreui/scss/variables";
447
+
@import"@coreui/coreui/scss/maps";
448
+
@import"@coreui/coreui/scss/mixins";
449
+
@import"@coreui/coreui/scss/utilities";
450
450
451
451
$utilities: map-merge(
452
452
$utilities, (
@@ -457,7 +457,7 @@ $utilities: map-merge(
457
457
)
458
458
);
459
459
460
-
@import"bootstrap/scss/utilities/api";
460
+
@import"@coreui/coreui/scss/utilities/api";
461
461
```
462
462
463
463
This will now generate responsive variations of `.border` and `.border-0` for each breakpoint. Your generated CSS will look like this:
@@ -497,11 +497,11 @@ This will now generate responsive variations of `.border` and `.border-0` for ea
497
497
Missing v4 utilities, or used to another naming convention? The utilities API can be used to override the resulting `class` of a given utility—for example, to rename `.ms-*` utilities to oldish `.ml-*`:
498
498
499
499
```scss
500
-
@import"bootstrap/scss/functions";
501
-
@import"bootstrap/scss/variables";
502
-
@import"bootstrap/scss/maps";
503
-
@import"bootstrap/scss/mixins";
504
-
@import"bootstrap/scss/utilities";
500
+
@import"@coreui/coreui/scss/functions";
501
+
@import"@coreui/coreui/scss/variables";
502
+
@import"@coreui/coreui/scss/maps";
503
+
@import"@coreui/coreui/scss/mixins";
504
+
@import"@coreui/coreui/scss/utilities";
505
505
506
506
$utilities: map-merge(
507
507
$utilities, (
@@ -512,34 +512,34 @@ $utilities: map-merge(
512
512
)
513
513
);
514
514
515
-
@import"bootstrap/scss/utilities/api";
515
+
@import"@coreui/coreui/scss/utilities/api";
516
516
```
517
517
518
518
### Remove utilities
519
519
520
520
Remove any of the default utilities with the [`map-remove()` Sass function](https://sass-lang.com/documentation/modules/map#remove).
521
521
522
522
```scss
523
-
@import"bootstrap/scss/functions";
524
-
@import"bootstrap/scss/variables";
525
-
@import"bootstrap/scss/maps";
526
-
@import"bootstrap/scss/mixins";
527
-
@import"bootstrap/scss/utilities";
523
+
@import"@coreui/coreui/scss/functions";
524
+
@import"@coreui/coreui/scss/variables";
525
+
@import"@coreui/coreui/scss/maps";
526
+
@import"@coreui/coreui/scss/mixins";
527
+
@import"@coreui/coreui/scss/utilities";
528
528
529
529
// Remove multiple utilities with a comma-separated list
You can also use the [`map-merge()` Sass function](https://sass-lang.com/documentation/modules/map#merge) and set the group key to `null` to remove the utility.
536
536
537
537
```scss
538
-
@import"bootstrap/scss/functions";
539
-
@import"bootstrap/scss/variables";
540
-
@import"bootstrap/scss/maps";
541
-
@import"bootstrap/scss/mixins";
542
-
@import"bootstrap/scss/utilities";
538
+
@import"@coreui/coreui/scss/functions";
539
+
@import"@coreui/coreui/scss/variables";
540
+
@import"@coreui/coreui/scss/maps";
541
+
@import"@coreui/coreui/scss/mixins";
542
+
@import"@coreui/coreui/scss/utilities";
543
543
544
544
$utilities: map-merge(
545
545
$utilities,
@@ -548,19 +548,19 @@ $utilities: map-merge(
548
548
)
549
549
);
550
550
551
-
@import"bootstrap/scss/utilities/api";
551
+
@import"@coreui/coreui/scss/utilities/api";
552
552
```
553
553
554
554
### Add, remove, modify
555
555
556
556
You can add, remove, and modify many utilities all at once with the [`map-merge()` Sass function](https://sass-lang.com/documentation/modules/map#merge). Here's how you can combine the previous examples into one larger map.
0 commit comments