Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/bootstrap.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Otto <markdotto@gmail.com>2020-11-03 21:44:03 +0300
committerXhmikosR <xhmikosr@gmail.com>2020-11-05 08:50:09 +0300
commit0766a096055a4f34c795e77f0e5c024310d20ef4 (patch)
treed4fbe09e38e9b434b8c560e5d29dc4011fe5ed76
parent5e270a13d1b35a81925a1067c89b082708c713ef (diff)
Big copy edits and testing
Moves the remote utilities section to the using the api section and updates the code snippet to work. Previous one removed all utilities.
-rw-r--r--site/content/docs/5.0/utilities/api.md40
1 files changed, 25 insertions, 15 deletions
diff --git a/site/content/docs/5.0/utilities/api.md b/site/content/docs/5.0/utilities/api.md
index aee021b4fb..17dfc45141 100644
--- a/site/content/docs/5.0/utilities/api.md
+++ b/site/content/docs/5.0/utilities/api.md
@@ -203,19 +203,13 @@ Output:
}
```
-### Remove utilities
-
-Utilities can also be removed by changing the group key to `null`:
+## Using the API
-```scss
-$utilities: (
- "float": 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.
-## Adding to existing utilities
+### Add 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
+ )
+);
+```