Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
theming.md 20.7 KB
Newer Older
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
1
2
3
4
5
6
7
8
9
10
11
12 
---
layout: docs
title: Theming Bootstrap
description: Customize Bootstrap 4 with our new built-in Sass variables for global style preferences for easy theming and component changes.
group: getting-started
toc: true
---

## Introduction

In Bootstrap 3, theming was largely driven by variable overrides in LESS, custom CSS, and a separate theme stylesheet that we included in our `dist` files. With some effort, one could completely redesign the look of Bootstrap 3 without touching the core files. Bootstrap 4 provides a familiar, but slightly different approach.
Gijs Boddeus's avatar
spelling changes to theming.md (#24444)    
Gijs Boddeus committed
13 
Now, theming is accomplished by Sass variables, Sass maps, and custom CSS. There's no more dedicated theme stylesheet; instead, you can enable the built-in theme to add gradients, shadows, and more.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
14
15
16 

## Sass
Martijn Cuppens's avatar
Sass precision documentation (#27705)    
Martijn Cuppens committed
17 
Utilize our source Sass files to take advantage of variables, maps, mixins, and more. In our build we've increased the Sass rounding precision to 6 (by default it's 5) to prevent issues with browser rounding.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
18
19
20 

### File structure
Mark Otto's avatar
fixes #24728    
Mark Otto committed
21 
Whenever possible, avoid modifying Bootstrap's core files. For Sass, that means creating your own stylesheet that imports Bootstrap so you can modify and extend it. Assuming you're using a package manager like npm, you'll have a file structure that looks like this:
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
22
23
24
25
26
27
28
29
30
31
32 

{% highlight plaintext %}
your-project/
├── scss
│   └── custom.scss
└── node_modules/
    └── bootstrap
        ├── js
        └── scss
{% endhighlight %}
Mark Otto's avatar
fixes #24728    
Mark Otto committed
33
34
35
36
37
38
39
40
41
42
43 
If you've downloaded our source files and aren't using a package manager, you'll want to manually setup something similar to that structure, keeping Bootstrap's source files separate from your own.

{% highlight plaintext %}
your-project/
├── scss
│   └── custom.scss
└── bootstrap/
    ├── js
    └── scss
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
44
45 
### Importing
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
46
47
48
49
50
51 
In your `custom.scss`, you'll import Bootstrap's source Sass files. You have two options: include all of Bootstrap, or pick the parts you need. We encourage the latter, though be aware there are some requirements and dependencies across our components. You also will need to include some JavaScript for our plugins.

{% highlight scss %}
// Custom.scss
// Option A: Include all of Bootstrap
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
52 
@import "../node_modules/bootstrap/scss/bootstrap";
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
53
54
55
56
57
58
59 
{% endhighlight %}

{% highlight scss %}
// Custom.scss
// Option B: Include parts of Bootstrap

// Required
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
60
61
62 
@import "../node_modules/bootstrap/scss/functions";
@import "../node_modules/bootstrap/scss/variables";
@import "../node_modules/bootstrap/scss/mixins";
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
63
64 

// Optional
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
65
66
67
68
69 
@import "../node_modules/bootstrap/scss/reboot";
@import "../node_modules/bootstrap/scss/type";
@import "../node_modules/bootstrap/scss/images";
@import "../node_modules/bootstrap/scss/code";
@import "../node_modules/bootstrap/scss/grid";
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
70
71 
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
72 
With that setup in place, you can begin to modify any of the Sass variables and maps in your `custom.scss`. You can also start to add parts of Bootstrap under the `// Optional` section as needed. We suggest using the full import stack from our `bootstrap.scss` file as your starting point.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
73
74
75 

### Variable defaults
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
76 
Every Sass variable in Bootstrap 4 includes the `!default` flag allowing you to override the variable's default value in your own Sass without modifying Bootstrap's source code. Copy and paste variables as needed, modify their values, and remove the `!default` flag. If a variable has already been assigned, then it won't be re-assigned by the default values in Bootstrap.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
77
Martijn Cuppens's avatar
Make component colors configurable (#28035)    
Martijn Cuppens committed
78 
You will find the complete list of Bootstrap's variables in `scss/_variables.scss`. Some variables are set to `null`, these variables don't output the property unless they are overridden in your configuration.
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
79
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
80
81
82 
Variable overrides within the same Sass file can come before or after the default variables. However, when overriding across Sass files, your overrides must come before you import Bootstrap's Sass files.

Here's an example that changes the `background-color` and `color` for the `<body>` when importing and compiling Bootstrap via npm:
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
83
84 

{% highlight scss %}
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
85
86
87
88
89 
// Your variable overrides
$body-bg: #000;
$body-color: #111;

// Bootstrap and its default variables
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
90 
@import "../node_modules/bootstrap/scss/bootstrap";
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
91
92 
{% endhighlight %}
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
93 
Repeat as necessary for any variable in Bootstrap, including the global options below.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
94
95
96
97
98 

### Maps and loops

Bootstrap 4 includes a handful of Sass maps, key value pairs that make it easier to generate families of related CSS. We use Sass maps for our colors, grid breakpoints, and more. Just like Sass variables, all Sass maps include the `!default` flag and can be overridden and extended.
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
99
100 
Some of our Sass maps are merged into empty ones by default. This is done to allow easy expansion of a given Sass map, but comes at the cost of making _removing_ items from a map slightly more difficult.
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
101
102 
#### Modify map
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
103 
To modify an existing color in our `$theme-colors` map, add the following to your custom Sass file:
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
104
105
106 

{% highlight scss %}
$theme-colors: (
Mark Otto's avatar
change away from vars    
Mark Otto committed
107
108 
  "primary": #0074d9,
  "danger": #ff4136
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
109
110
111 
);
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
112
113 
#### Add to map
Mark Otto's avatar
add new thing to a map    
Mark Otto committed
114
115
116
117
118
119
120 
To add a new color to `$theme-colors`, add the new key and value:

{% highlight scss %}
$theme-colors: (
  "custom-color": #900
);
{% endhighlight %}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
121
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
122
123 
#### Remove from map
ysds's avatar
Update themeing docs for more clearly how to remove from map (#25589)    
ysds committed
124 
To remove colors from `$theme-colors`, or any other map, use `map-remove`. Be aware you must insert it between our requirements and options:
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
125
126 

{% highlight scss %}
ysds's avatar
Update themeing docs for more clearly how to remove from map (#25589)    
ysds committed
127 
// Required
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
128
129
130 
@import "../node_modules/bootstrap/scss/functions";
@import "../node_modules/bootstrap/scss/variables";
@import "../node_modules/bootstrap/scss/mixins";
ysds's avatar
Update themeing docs for more clearly how to remove from map (#25589)    
ysds committed
131
132
133
134 

$theme-colors: map-remove($theme-colors, "info", "light", "dark");

// Optional
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
135
136
137 
@import "../node_modules/bootstrap/scss/root";
@import "../node_modules/bootstrap/scss/reboot";
@import "../node_modules/bootstrap/scss/type";
ysds's avatar
Update themeing docs for more clearly how to remove from map (#25589)    
ysds committed
138 
...
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
139
140 
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
141
142
143
144
145
146 
#### Required keys

Bootstrap assumes the presence of some specific keys within Sass maps as we used and extend these ourselves. As you customize the included maps, you may encounter errors where a specific Sass map's key is being used.

For example, we use the `primary`, `success`, and `danger` keys from `$theme-colors` for links, buttons, and form states. Replacing the values of these keys should present no issues, but removing them may cause Sass compilation issues. In these instances, you'll need to modify the Sass code that makes use of those values.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
147
148 
### Functions
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
149 
Bootstrap utilizes several Sass functions, but only a subset are applicable to general theming. We've included three functions for getting values from the color maps:
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
150
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194 
{% highlight scss %}
@function color($key: "blue") {
  @return map-get($colors, $key);
}

@function theme-color($key: "primary") {
  @return map-get($theme-colors, $key);
}

@function gray($key: "100") {
  @return map-get($grays, $key);
}
{% endhighlight %}

These allow you to pick one color from a Sass map much like how you'd use a color variable from v3.

{% highlight scss %}
.custom-element {
  color: gray("100");
  background-color: theme-color("dark");
}
{% endhighlight %}

We also have another function for getting a particular _level_ of color from the `$theme-colors` map. Negative level values will lighten the color, while higher levels will darken.

{% highlight scss %}
@function theme-color-level($color-name: "primary", $level: 0) {
  $color: theme-color($color-name);
  $color-base: if($level > 0, #000, #fff);
  $level: abs($level);

  @return mix($color-base, $color, $level * $theme-color-interval);
}
{% endhighlight %}

In practice, you'd call the function and pass in two parameters: the name of the color from `$theme-colors` (e.g., primary or danger) and a numeric level.

{% highlight scss %}
.custom-element {
  color: theme-color-level(primary, -10);
}
{% endhighlight %}

Additional functions could be added in the future or your own custom Sass to create level functions for additional Sass maps, or even a generic one if you wanted to be more verbose.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
195
Gaël Poupard's avatar
docs(theming): improve headings hierarchy under Sass → Functions (#30207)    
Gaël Poupard committed
196 
#### Color contrast
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
197
Martijn Cuppens's avatar
Backport "Use escape-svg() function (#29077)"    
Martijn Cuppens committed
198 
An additional function we include in Bootstrap is the color contrast function, `color-yiq`. It utilizes the [YIQ color space](https://en.wikipedia.org/wiki/YIQ) to automatically return a light (`#fff`) or dark (`#111`) contrast color based on the specified base color. This function is especially useful for mixins or loops where you're generating multiple classes.
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225 

For example, to generate color swatches from our `$theme-colors` map:

{% highlight scss %}
@each $color, $value in $theme-colors {
  .swatch-#{$color} {
    color: color-yiq($value);
  }
}
{% endhighlight %}

It can also be used for one-off contrast needs:

{% highlight scss %}
.custom-element {
  color: color-yiq(#000); // returns `color: #fff`
}
{% endhighlight %}

You can also specify a base color with our color map functions:

{% highlight scss %}
.custom-element {
  color: color-yiq(theme-color("dark")); // returns `color: #fff`
}
{% endhighlight %}
Gaël Poupard's avatar
docs(theming): improve headings hierarchy under Sass → Functions (#30207)    
Gaël Poupard committed
226 
#### Escape SVG
Martijn Cuppens's avatar
Backport "Use escape-svg() function (#29077)"    
Martijn Cuppens committed
227
XhmikosR's avatar
Backport 65d130fbd85abd8143c553e75e24bc5a11d36877    
XhmikosR committed
228 
We use the `escape-svg` function to escape the `<`, `>` and `#` characters for SVG background images. These characters need to be escaped to properly render the background images in IE. When using the `escape-svg` function, data URIs must be quoted.
Martijn Cuppens's avatar
Backport "Use escape-svg() function (#29077)"    
Martijn Cuppens committed
229
Gaël Poupard's avatar
docs(theming): improve headings hierarchy under Sass → Functions (#30207)    
Gaël Poupard committed
230 
#### Add and Subtract functions
ysds's avatar
Add add and subtract function    
ysds committed
231
Mark Otto's avatar
Doc tweaks.    
Mark Otto committed
232 
We use the `add` and `subtract` functions to wrap the CSS `calc` function. The primary purpose of these functions is to avoid errors when a "unitless" `0` value is passed into a `calc` expression. Expressions like `calc(10px - 0)` will return an error in all browsers, despite being mathematically correct.
ysds's avatar
Add add and subtract function    
ysds committed
233
234
235 

Example where the calc is valid:
XhmikosR's avatar
Fix highlighting.    
XhmikosR committed
236 
{% highlight scss %}
ysds's avatar
Add add and subtract function    
ysds committed
237
238
239
240
241
242
243
244
245
246
247
248 
$border-radius: .25rem;
$border-width: 1px;

.element {
  // Output calc(.25rem - 1px) is valid
  border-radius: calc($border-radius - $border-width);
}

.element {
  // Output the same calc(.25rem - 1px) as above
  border-radius: subtract($border-radius, $border-width);
}
XhmikosR's avatar
Fix highlighting.    
XhmikosR committed
249 
{% endhighlight %}
ysds's avatar
Add add and subtract function    
ysds committed
250
251
252 

Example where the calc is invalid:
XhmikosR's avatar
Fix highlighting.    
XhmikosR committed
253 
{% highlight scss %}
ysds's avatar
Add add and subtract function    
ysds committed
254
255
256
257
258
259
260
261
262
263
264
265 
$border-radius: .25rem;
$border-width: 0;

.element {
  // Output calc(.25rem - 0) is invalid
  border-radius: calc($border-radius - $border-width);
}

.element {
  // Output .25rem
  border-radius: subtract($border-radius, $border-width);
}
XhmikosR's avatar
Fix highlighting.    
XhmikosR committed
266 
{% endhighlight %}
ysds's avatar
Add add and subtract function    
ysds committed
267
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
268
269 
## Sass options
Mark Otto's avatar
port over variable options list    
Mark Otto committed
270
271 
Customize Bootstrap 4 with our built-in custom variables file and easily toggle global CSS preferences with new `$enable-*` Sass variables. Override a variable's value and recompile with `npm run test` as needed.
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
272 
You can find and customize these variables for key global options in Bootstrap's `scss/_variables.scss` file.
Mark Otto's avatar
port over variable options list    
Mark Otto committed
273
Martijn Cuppens's avatar
Move hand cursor for buttons to reboot    
Martijn Cuppens committed
274
275
276
277
278
279
280
281
282
283
284
285
286 
| Variable                                     | Values                             | Description                                                                            |
| -------------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------------- |
| `$spacer`                                    | `1rem` (default), or any value > 0 | Specifies the default spacer value to programmatically generate our [spacer utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/spacing/). |
| `$enable-rounded`                            | `true` (default) or `false`        | Enables predefined `border-radius` styles on various components. |
| `$enable-shadows`                            | `true` or `false` (default)        | Enables predefined `box-shadow` styles on various components. |
| `$enable-gradients`                          | `true` or `false` (default)        | Enables predefined gradients via `background-image` styles on various components. |
| `$enable-transitions`                        | `true` (default) or `false`        | Enables predefined `transition`s on various components. |
| `$enable-prefers-reduced-motion-media-query` | `true` (default) or `false`        | Enables the [`prefers-reduced-motion` media query]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/accessibility/#reduced-motion), which suppresses certain animations/transitions based on the users' browser/operating system preferences. |
| `$enable-hover-media-query`                  | `true` or `false` (default)        | **Deprecated** |
| `$enable-grid-classes`                       | `true` (default) or `false`        | Enables the generation of CSS classes for the grid system (e.g., `.container`, `.row`, `.col-md-1`, etc.). |
| `$enable-caret`                              | `true` (default) or `false`        | Enables pseudo element caret on `.dropdown-toggle`. |
| `$enable-pointer-cursor-for-buttons`         | `true` (default) or `false`        | Add "hand" cursor to non-disabled button elements. |
| `$enable-print-styles`                       | `true` (default) or `false`        | Enables styles for optimizing printing. |
Martijn Cuppens's avatar
Responsive font size implementation (#23816)    
Martijn Cuppens committed
287 
| `$enable-responsive-font-sizes`              | `true` or `false` (default)        | Enables [responsive font sizes]({{ site.baseurl }}/docs/{{ site.docs_version }}/content/typography/#responsive-font-sizes). |
Martijn Cuppens's avatar
Move hand cursor for buttons to reboot    
Martijn Cuppens committed
288 
| `$enable-validation-icons`                   | `true` (default) or `false`        | Enables `background-image` icons within textual inputs and some custom forms for validation states. |
Martijn Cuppens's avatar
Add `deprecate()` mixin (#28092)    
Martijn Cuppens committed
289 
| `$enable-deprecation-messages`               | `true` or `false` (default)        | Set to `true` to show warnings when using any of the deprecated mixins and functions that are planned to be removed in `v5`. |
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
290
Mark Otto's avatar
bring over colors section    
Mark Otto committed
291 
## Color
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
292
Mark Otto's avatar
bring over colors section    
Mark Otto committed
293
294
295
296 
Many of Bootstrap's various components and utilities are built through a series of colors defined in a Sass map. This map can be looped over in Sass to quickly generate a series of rulesets.

### All colors
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
297 
All colors available in Bootstrap 4, are available as Sass variables and a Sass map in `scss/_variables.scss` file. This will be expanded upon in subsequent minor releases to add additional shades, much like the [grayscale palette](#grays) we already include.
Mark Otto's avatar
bring over colors section    
Mark Otto committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320 

<div class="row">
  {% for color in site.data.colors %}
    {% unless color.name == "white" or color.name == "gray" or color.name == "gray-dark" %}
    <div class="col-md-4">
        <div class="p-3 mb-3 swatch-{{ color.name }}">{{ color.name | capitalize }}</div>
    </div>
    {% endunless %}
  {% endfor %}
</div>

Here's how you can use these in your Sass:

{% highlight scss %}
// With variable
.alpha { color: $purple; }

// From the Sass map with our `color()` function
.beta { color: color("purple"); }
{% endhighlight %}

[Color utility classes]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/colors/) are also available for setting `color` and `background-color`.
m5o's avatar
Use callout without custom Jekyll plugin.    
m5o committed
321 
{% capture callout %}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
322 
In the future, we'll aim to provide Sass maps and variables for shades of each color as we've done with the grayscale colors below.
m5o's avatar
Use callout without custom Jekyll plugin.    
m5o committed
323
324 
{% endcapture %}
{% include callout.html content=callout type="info" %}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
325
326
327 

### Theme colors
Martijn Cuppens's avatar
Typo fix (#28920)    
Martijn Cuppens committed
328 
We use a subset of all colors to create a smaller color palette for generating color schemes, also available as Sass variables and a Sass map in Bootstrap's `scss/_variables.scss` file.
Mark Otto's avatar
bring over colors section    
Mark Otto committed
329
330
331
332 

<div class="row">
  {% for color in site.data.theme-colors %}
    <div class="col-md-4">
XhmikosR's avatar
docs: remove swatches for theme colors. (#29327)    
XhmikosR committed
333 
      <div class="p-3 mb-3 bg-{{ color.name }} {% if color.name == "light" or color.name == "warning" %}text-dark{% else %}text-white{% endif %}">{{ color.name | capitalize }}</div>
Mark Otto's avatar
bring over colors section    
Mark Otto committed
334
335
336
337
338
339 
    </div>
  {% endfor %}
</div>

### Grays
Patrick H. Lauke's avatar
Docs: add note about the grays being "cool" (#27824)    
Patrick H. Lauke committed
340 
An expansive set of gray variables and a Sass map in `scss/_variables.scss` for consistent shades of gray across your project. Note that these are "cool grays", which tend towards a subtle blue tone, rather than neutral grays.
Mark Otto's avatar
bring over colors section    
Mark Otto committed
341
342
343
344
345
346
347
348
349 

<div class="row mb-3">
  <div class="col-md-4">
    {% for color in site.data.grays %}
      <div class="p-3 swatch-{{ color.name }}">{{ color.name | capitalize }}</div>
    {% endfor %}
  </div>
</div>
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
350 
Within `scss/_variables.scss`, you'll find Bootstrap's color variables and Sass map. Here's an example of the `$colors` Sass map:
Mark Otto's avatar
bring over colors section    
Mark Otto committed
351
352
353 

{% highlight scss %}
$colors: (
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
354
355
356
357 
  "blue": $blue,
  "indigo": $indigo,
  "purple": $purple,
  "pink": $pink,
Mark Otto's avatar
quote those to match source code    
Mark Otto committed
358
359
360
361
362 
  "red": $red,
  "orange": $orange,
  "yellow": $yellow,
  "green": $green,
  "teal": $teal,
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
363 
  "cyan": $cyan,
Mark Otto's avatar
quote those to match source code    
Mark Otto committed
364
365 
  "white": $white,
  "gray": $gray-600,
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
366 
  "gray-dark": $gray-800
Mark Otto's avatar
bring over colors section    
Mark Otto committed
367
368
369
370
371 
) !default;
{% endhighlight %}

Add, remove, or modify values within the map to update how they're used in many other components. Unfortunately at this time, not _every_ component utilizes this Sass map. Future updates will strive to improve upon this. Until then, plan on making use of the `${color}` variables and this Sass map.
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
372
373 
## Components
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412 
Many of Bootstrap's components and utilities are built with `@each` loops that iterate over a Sass map. This is especially helpful for generating variants of a component by our `$theme-colors` and creating responsive variants for each breakpoint. As you customize these Sass maps and recompile, you'll automatically see your changes reflected in these loops.

### Modifiers

Many of Bootstrap's components are built with a base-modifier class approach. This means the bulk of the styling is contained to a base class (e.g., `.btn`) while style variations are confined to modifier classes (e.g., `.btn-danger`). These modifier classes are built from the `$theme-colors` map to make customizing the number and name of our modifier classes.

Here are two examples of how we loop over the `$theme-colors` map to generate modifiers to the `.alert` component and all our `.bg-*` background utilities.

{% highlight scss %}
// Generate alert modifier classes
@each $color, $value in $theme-colors {
  .alert-#{$color} {
    @include alert-variant(theme-color-level($color, -10), theme-color-level($color, -9), theme-color-level($color, 6));
  }
}

// Generate `.bg-*` color utilities
@each $color, $value in $theme-colors {
  @include bg-variant('.bg-#{$color}', $value);
}
{% endhighlight %}

### Responsive

These Sass loops aren't limited to color maps, either. You can also generate responsive variations of your components or utilities. Take for example our responsive text alignment utilities where we mix an `@each` loop for the `$grid-breakpoints` Sass map with a media query include.

{% highlight scss %}
@each $breakpoint in map-keys($grid-breakpoints) {
  @include media-breakpoint-up($breakpoint) {
    $infix: breakpoint-infix($breakpoint, $grid-breakpoints);

    .text#{$infix}-left   { text-align: left !important; }
    .text#{$infix}-right  { text-align: right !important; }
    .text#{$infix}-center { text-align: center !important; }
  }
}
{% endhighlight %}

Should you need to modify your `$grid-breakpoints`, your changes will apply to all the loops iterating over that map.
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
413
414
415 

## CSS variables
XhmikosR's avatar
Fix redirects. (#29254)    
XhmikosR committed
416 
Bootstrap 4 includes around two dozen [CSS custom properties (variables)](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) in its compiled CSS. These provide easy access to commonly used values like our theme colors, breakpoints, and primary font stacks when working in your browser's Inspector, a code sandbox, or general prototyping.
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449 

### Available variables

Here are the variables we include (note that the `:root` is required). They're located in our `_root.scss` file.

{% highlight css %}
:root {
  --blue: #007bff;
  --indigo: #6610f2;
  --purple: #6f42c1;
  --pink: #e83e8c;
  --red: #dc3545;
  --orange: #fd7e14;
  --yellow: #ffc107;
  --green: #28a745;
  --teal: #20c997;
  --cyan: #17a2b8;
  --white: #fff;
  --gray: #6c757d;
  --gray-dark: #343a40;
  --primary: #007bff;
  --secondary: #6c757d;
  --success: #28a745;
  --info: #17a2b8;
  --warning: #ffc107;
  --danger: #dc3545;
  --light: #f8f9fa;
  --dark: #343a40;
  --breakpoint-xs: 0;
  --breakpoint-sm: 576px;
  --breakpoint-md: 768px;
  --breakpoint-lg: 992px;
  --breakpoint-xl: 1200px;
XhmikosR's avatar
theming.md: bring `:root` up to par with Scss. (#29323)    
XhmikosR committed
450 
  --font-family-sans-serif: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467 
  --font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
}
{% endhighlight %}

### Examples

CSS variables offer similar flexibility to Sass's variables, but without the need for compilation before being served to the browser. For example, here we're resetting our page's font and link styles with CSS variables.

{% highlight css %}
body {
  font: 1rem/1.5 var(--font-family-sans-serif);
}
a {
  color: var(--blue);
}
{% endhighlight %}
Mark Otto's avatar
add examples to theming docs section on css vars in media queries, closes #26205    
Mark Otto committed
468
469 
### Breakpoint variables
XhmikosR's avatar
Move periods outside of links.    
XhmikosR committed
470 
While we originally included breakpoints in our CSS variables (e.g., `--breakpoint-md`), **these are not supported in media queries**, but they can still be used _within_ rulesets in media queries. These breakpoint variables remain in the compiled CSS for backward compatibility given they can be utilized by JavaScript. [Learn more in the spec](https://www.w3.org/TR/css-variables-1/#using-variables).
Mark Otto's avatar
add examples to theming docs section on css vars in media queries, closes #26205    
Mark Otto committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488 

Here's an example of **what's not supported:**

{% highlight css %}
@media (min-width: var(--breakpoint-sm)) {
  ...
}
{% endhighlight %}

And here's an example of **what is supported:**

{% highlight css %}
@media (min-width: 768px) {
  .custom-element {
    color: var(--primary);
  }
}
{% endhighlight %}