rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2025-03-21 13:29:00 +01:00
Code Issues Actions 10 Packages Releases Activity

Big copy edits and testing

Browse Source 
Moves the remote utilities section to the using the api section and updates the code snippet to work. Previous one removed all utilities.
This commit is contained in:
Mark Otto 2020-11-03 10:44:03 -08:00 committed by XhmikosR
parent 5e270a13d1
commit 0766a09605
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
site/content/docs/5.0/utilities/api.md
View File

@ -203,19 +203,13 @@ Output:
}
```
### Remove utilities
## Using the API
Utilities can also be removed by changing the group key to `null`:
Now that you're familiar with how the utilities API works, learn how to add your own custom classes and modify our default utilities.
```scss
$utilities: (
"float": null,
);
```
### Add utilities
## Adding to existing utilities
Add new utilities with `map-merge`.Start by importing the utilities stylesheet, then use `map-merge` to add new properties and values.s
New utilities can be added to the default `$utilities` map with a `map-merge`. Make sure our `_utilities.scss` is 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.
```scss
@import "bootstrap/scss/utilities";
@ -223,18 +217,19 @@ Add new utilities with `map-merge`.Start by importing the utilities stylesheet,
$utilities: map-merge(
$utilities,
(
"font-size": (
"cursor": (
property: cursor,
class: cursor
responsive: true,
property: font-weight,
values: $display-font-sizes,
values: auto pointer grab,
)
)
);
```
## Modifying existing utilities
### Modify utilities
Modify existing utilities with `map-get` and `map-merge`. Once again, be sure to import the utilities stylesheet before your custom utilities.
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.
```scss
@import "bootstrap/scss/utilities";
@ -254,3 +249,18 @@ $utilities: map-merge(
)
);
```
### Remove utilities
Remove any of the default utilities by setting the group key to `null`. For example, to remove all our `width` utilities, create a `$utilities` `map-merge` and add `"width": null` within.
```scss
@import "bootstrap/scss/utilities";
$utilities: map-merge(
$utilities,
(
"width": null
)
);
```