Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
theming.md 19.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
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
23 
{{< highlight text >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
24
25
26
27
28
29
30 
your-project/
├── scss
│   └── custom.scss
└── node_modules/
    └── bootstrap
        ├── js
        └── scss
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
31 
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
32
Mark Otto's avatar
fixes #24728    
Mark Otto committed
33
34 
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.
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
35 
{{< highlight text >}}
Mark Otto's avatar
fixes #24728    
Mark Otto committed
36
37
38
39
40
41 
your-project/
├── scss
│   └── custom.scss
└── bootstrap/
    ├── js
    └── scss
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
42 
{{< /highlight >}}
Mark Otto's avatar
fixes #24728    
Mark Otto committed
43
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 
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.
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
48 
{{< highlight scss >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
49
50
51 
// 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";
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
53 
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
54
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
55 
{{< highlight scss >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
56
57
58
59 
// 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";
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
70 
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
71
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
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
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";
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
91 
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
92
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 

### Maps and loops
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
97 
Bootstrap 5 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
Stub out new Theming page  
Mark Otto committed
98
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
99 
From Bootstrap 5, we decided to [ditch the map merges](https://github.com/twbs/bootstrap/pull/28508) we had in `v4`. This way we have more control over removing redundant values.
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
100
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
101
102 
#### Modify map
Martijn Cuppens's avatar
Drop `color()`, `theme-color()` & `gray()` functions (#29083)    
Martijn Cuppens committed
103
104
105
106
107
108
109
110 
All variables in the `$theme-colors` map are defined as standalone variables. To modify an existing color in our `$theme-colors` map, add the following to your custom Sass file:

{{< highlight scss >}}
$primary: #0074d9;
$danger: #ff4136;
{{< /highlight >}}

Later on, theses variables are set in Bootstrap's `$theme-colors` map:
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
111
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
112 
{{< highlight scss >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
113 
$theme-colors: (
Martijn Cuppens's avatar
Drop `color()`, `theme-color()` & `gray()` functions (#29083)    
Martijn Cuppens committed
114 
  "primary": $primary,
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
115
116 
  "danger": $danger,
  ...
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
117 
);
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
118 
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
119
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
120
121 
#### Add to map
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
122 
To add a new color to `$theme-colors`, add the new key and value. Keep in mind not to remove the existing colors:
Mark Otto's avatar
add new thing to a map    
Mark Otto committed
123
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
124 
{{< highlight scss >}}
Gaël Poupard's avatar
Use correct hex color code(#30533)    
Gaël Poupard committed
125 
$my-custom-color: #ff00dd;
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
126
127 

// Make sure to define `$primary`, `$secondary`, ect.. first
Mark Otto's avatar
add new thing to a map    
Mark Otto committed
128 
$theme-colors: (
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
129
130
131
132
133
134
135
136
137 
  "primary":      $primary,
  "secondary":    $secondary,
  "success":      $success,
  "info":         $info,
  "warning":      $warning,
  "danger":       $danger,
  "light":        $light,
  "dark":         $dark,
  "custom-color": $my-custom-color,
Mark Otto's avatar
add new thing to a map    
Mark Otto committed
138 
);
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
139 
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
140
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
141
142 
#### Remove from map
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
143 
From Bootstrap 5, this is simplified quite a lot, just remove the redundant items from the Sass map:
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
144
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
145 
{{< highlight scss >}}
Martijn Cuppens's avatar
Remove map merges (#28508)    
Martijn Cuppens committed
146
147
148
149
150
151
152
153 
// Make sure to define `$primary`, `$secondary`, ect.. first
$theme-colors: (
  "primary":      $primary,
  "secondary":    $secondary,
  "success":      $success,
  "warning":      $warning,
  "danger":       $danger,
);
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
154 
{{< /highlight >}}
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
155
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
156
157
158
159
160
161 
#### 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
162
163 
### Functions
Martijn Cuppens's avatar
Drop `color()`, `theme-color()` & `gray()` functions (#29083)    
Martijn Cuppens committed
164 
In Bootstrap 5, we've dropped the `color()`, `theme-color()` and `gray()` functions because the values are also available as standalone variables. So instead of using `theme-color("primary")`, you can now just use the `$primary` variable.
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
165
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
166 
{{< highlight scss >}}
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
167 
.custom-element {
Martijn Cuppens's avatar
Drop `color()`, `theme-color()` & `gray()` functions (#29083)    
Martijn Cuppens committed
168
169 
  color: $gray-100;
  background-color: $dark;
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
170 
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
171 
{{< /highlight >}}
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
172
Martijn Cuppens's avatar
Drop `color()`, `theme-color()` & `gray()` functions (#29083)    
Martijn Cuppens committed
173 
We also have a function for getting a particular _level_ of color. Negative level values will lighten the color, while higher levels will darken.
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
174
Martijn Cuppens's avatar
Create `scss-docs` shortcode to get some snippets from the Scs… (#30502)    
Martijn Cuppens committed
175 
{{< scss-docs name="color-level" file="scss/_functions.scss" >}}
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
176
177
178 

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.
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
179 
{{< highlight scss >}}
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
180 
.custom-element {
Martijn Cuppens's avatar
Drop `color()`, `theme-color()` & `gray()` functions (#29083)    
Martijn Cuppens committed
181 
  color: color-level($primary, -10);
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
182 
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
183 
{{< /highlight >}}
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
184
Gaël Poupard's avatar
docs(theming): improve headings hierarchy under Sass → Functions (#30207)    
Gaël Poupard committed
185 
#### Color contrast
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
186
Gaël Poupard's avatar
Use WCAG contrast algo (#30168)    
Gaël Poupard committed
187 
An additional function we include in Bootstrap is the color contrast function, `color-contrast`. It utilizes the [WCAG 2.0 algorithm](https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests) for calculating contrast thresholds based on [relative luminance](https://www.w3.org/WAI/GL/wiki/Relative_luminance) in a `sRGB` colorspace 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
188
189
190 

For example, to generate color swatches from our `$theme-colors` map:
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
191 
{{< highlight scss >}}
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
192
193 
@each $color, $value in $theme-colors {
  .swatch-#{$color} {
Gaël Poupard's avatar
Use WCAG contrast algo (#30168)    
Gaël Poupard committed
194 
    color: color-contrast($value);
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
195
196 
  }
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
197 
{{< /highlight >}}
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
198
199
200 

It can also be used for one-off contrast needs:
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
201 
{{< highlight scss >}}
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
202 
.custom-element {
Gaël Poupard's avatar
Use WCAG contrast algo (#30168)    
Gaël Poupard committed
203 
  color: color-contrast(#000); // returns `color: #fff`
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
204 
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
205 
{{< /highlight >}}
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
206
207
208 

You can also specify a base color with our color map functions:
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
209 
{{< highlight scss >}}
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
210 
.custom-element {
Gaël Poupard's avatar
Use WCAG contrast algo (#30168)    
Gaël Poupard committed
211 
  color: color-contrast($dark); // returns `color: #fff`
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
212 
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
213 
{{< /highlight >}}
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
214
Gaël Poupard's avatar
Use WCAG contrast algo (#30168)    
Gaël Poupard committed
215
216
217
218
219
220 
{{< callout info >}}
##### Accessibility

In order to meet [WCAG 2.0 accessibility standards for color contrast](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-contrast.html), authors **must** provide [a contrast ratio of at least 4.5:1](https://www.w3.org/WAI/WCAG20/quickref/20160105/Overview.php#visual-audio-contrast-contrast), with very few exceptions.
{{< /callout >}}
Gaël Poupard's avatar
docs(theming): improve headings hierarchy under Sass → Functions (#30207)    
Gaël Poupard committed
221 
#### Escape SVG
Martijn Cuppens's avatar
Use escape-svg() function (#29077)    
Martijn Cuppens committed
222
XhmikosR's avatar
Remove Internet Explorer leftovers    
XhmikosR committed
223 
We use the `escape-svg` function to escape the `<`, `>` and `#` characters for SVG background images.
Martijn Cuppens's avatar
Use escape-svg() function (#29077)    
Martijn Cuppens committed
224
Gaël Poupard's avatar
docs(theming): improve headings hierarchy under Sass → Functions (#30207)    
Gaël Poupard committed
225 
#### Add and Subtract functions
ysds's avatar
Add add and subtract function    
ysds committed
226
Mark Otto's avatar
Doc tweaks.    
Mark Otto committed
227 
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262 

Example where the calc is valid:

{{< highlight scss >}}
$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);
}
{{< /highlight >}}

Example where the calc is invalid:

{{< highlight scss >}}
$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);
}
{{< /highlight >}}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
263
264 
## Sass options
Mark Otto's avatar
port over variable options list    
Mark Otto committed
265
266 
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
267 
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
268
Martijn Cuppens's avatar
Move hand cursor for buttons to reboot    
Martijn Cuppens committed
269
270 
| Variable                                     | Values                             | Description                                                                            |
| -------------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------------- |
XhmikosR's avatar
Add a docsref shortcode.    
XhmikosR committed
271 
| `$spacer`                                    | `1rem` (default), or any value > 0 | Specifies the default spacer value to programmatically generate our [spacer utilities]({{< docsref "/utilities/spacing" >}}). |
Martijn Cuppens's avatar
Move hand cursor for buttons to reboot    
Martijn Cuppens committed
272
273
274
275 
| `$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. |
XhmikosR's avatar
Add a docsref shortcode.    
XhmikosR committed
276 
| `$enable-prefers-reduced-motion-media-query` | `true` (default) or `false`        | Enables the [`prefers-reduced-motion` media query]({{< docsref "/getting-started/accessibility#reduced-motion" >}}), which suppresses certain animations/transitions based on the users' browser/operating system preferences. |
Martijn Cuppens's avatar
Split grid & containers (#29146)    
Martijn Cuppens committed
277 
| `$enable-grid-classes`                       | `true` (default) or `false`        | Enables the generation of CSS classes for the grid system (e.g. `.row`, `.col-md-1`, etc.). |
Martijn Cuppens's avatar
Move hand cursor for buttons to reboot    
Martijn Cuppens committed
278
279 
| `$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. |
Martijn Cuppens's avatar
Disable negative margins by default (#30585)    
Martijn Cuppens committed
280 
| `$enable-rfs`                                | `true` (default) or `false`        | Globally enables [RFS]({{< docsref "/getting-started/rfs" >}}). |
Martijn Cuppens's avatar
Move hand cursor for buttons to reboot    
Martijn Cuppens committed
281 
| `$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
Disable negative margins by default (#30585)    
Martijn Cuppens committed
282 
| `$enable-negative-margins`                   | `true` or `false` (default)        | Enables the generation of [negative margin utilities]({{< docsref "/utilities/spacing#negative-margin" >}}). |
Martijn Cuppens's avatar
Add `deprecate()` mixin (#28092)    
Martijn Cuppens committed
283 
| `$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`. |
Martijn Cuppens's avatar
Introduce posibility to disable !important suffix for utility classes (#29625)    
Martijn Cuppens committed
284 
| `$enable-important-utilities`                | `true` (default) or `false`        | Enables the `!important` suffix in utility classes. |
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
285
Mark Otto's avatar
bring over colors section    
Mark Otto committed
286 
## Color
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
287
Mark Otto's avatar
bring over colors section    
Mark Otto committed
288
289
290
291 
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
Ty Mick's avatar
Remove unnecessary comma in 'All colors' (#30010)    
Ty Mick committed
292 
All colors available in Bootstrap 5 are available as Sass variables and as a Sass map in `scss/_variables.scss`. To avoid increased file sizes, we do not create classes for each of these variables.
Mark Otto's avatar
v5: Update colors to add shades and tints (#29348)    
Mark Otto committed
293
294
295
296 

Sass cannot programmatically generate variables, so we must manually create them ourselves. We specify the midpoint value (`500`) and use custom color functions to tint (lighten) or shade (darken) our colors via Sass's `mix()` color function. Using `mix()` is not the same as `lighten()` and `darken()`—the former blends the specified color with white or black, while the latter only adjusts the lightness value of each color. The result is a much more complete suite of colors, as [shown in this CodePen demo](https://codepen.io/emdeoh/pen/zYOQOPB).

Our `tint-color()` and `shade-color()` functions use `mix()` alongside our `$theme-color-interval` variable, which specifies a stepped percentage value for each mixed color we need. See the `scss/_functions.scss` and `scss/_variables.scss` files for the full source code.
Mark Otto's avatar
bring over colors section    
Mark Otto committed
297
298 

<div class="row">
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
299 
  {{< theme-colors.inline >}}
Mark Otto's avatar
v5: Update colors to add shades and tints (#29348)    
Mark Otto committed
300
301
302
303
304
305
306
307
308
309 
  {{- range $color := $.Site.Data.colors }}
    {{- if (and (not (eq $color.name "white")) (not (eq $color.name "gray")) (not (eq $color.name "gray-dark"))) }}
    <div class="col-md-4 mb-3 font-monospace">
      <div class="p-3 mb-2 swatch-{{ $color.name }}">
        <strong class="d-block">${{ $color.name }}</strong>
        {{ $color.hex }}
      </div>
      {{ range (seq 100 100 900) }}
      <div class="p-3 bd-{{ $color.name }}-{{ . }}">${{ $color.name }}-{{ . }}</div>
      {{ end }}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
310 
    </div>
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
311
312
313 
    {{ end -}}
  {{ end -}}
  {{< /theme-colors.inline >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
314
315
316
317 
</div>

Here's how you can use these in your Sass:
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
318 
{{< highlight scss >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
319 
.alpha { color: $purple; }
Mark Otto's avatar
v5: Update colors to add shades and tints (#29348)    
Mark Otto committed
320
321
322
323 
.beta {
  color: $yellow-300;
  background-color: $indigo-900;
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
324 
{{< /highlight >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
325
XhmikosR's avatar
Add a docsref shortcode.    
XhmikosR committed
326 
[Color utility classes]({{< docsref "/utilities/colors" >}}) are also available for setting `color` and `background-color`.
Mark Otto's avatar
bring over colors section    
Mark Otto committed
327
328
329 

### Theme colors
Martijn Cuppens's avatar
Typo fix (#28920)    
Martijn Cuppens committed
330 
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
331
332 

<div class="row">
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
333
334 
  {{< theme-colors.inline >}}
  {{- range (index $.Site.Data "theme-colors") }}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
335 
    <div class="col-md-4">
XhmikosR's avatar
docs: remove swatches for theme colors. (#29327)    
XhmikosR committed
336 
      <div class="p-3 mb-3 bg-{{ .name }} {{ if or (eq .name "light") (eq .name "warning") }}text-dark{{ else }}text-white{{ end }}">{{ .name | title }}</div>
Mark Otto's avatar
bring over colors section    
Mark Otto committed
337 
    </div>
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
338
339 
  {{ end -}}
  {{< /theme-colors.inline >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
340
341
342
343 
</div>

### Grays
Patrick H. Lauke's avatar
Docs: add note about the grays being "cool" (#27824)    
Patrick H. Lauke committed
344 
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
345
346
347 

<div class="row mb-3">
  <div class="col-md-4">
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
348
349
350
351
352 
    {{< theme-colors.inline >}}
    {{- range $.Site.Data.grays }}
      <div class="p-3 swatch-{{ .name }}">{{ .name }}</div>
    {{ end -}}
  {{< /theme-colors.inline >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
353
354
355 
  </div>
</div>
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
356 
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
357
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
358 
{{< highlight scss >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
359 
$colors: (
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
360
361
362
363 
  "blue": $blue,
  "indigo": $indigo,
  "purple": $purple,
  "pink": $pink,
Mark Otto's avatar
quote those to match source code    
Mark Otto committed
364
365
366
367
368 
  "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
369 
  "cyan": $cyan,
Mark Otto's avatar
quote those to match source code    
Mark Otto committed
370
371 
  "white": $white,
  "gray": $gray-600,
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
372 
  "gray-dark": $gray-800
Mark Otto's avatar
bring over colors section    
Mark Otto committed
373 
) !default;
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
374 
{{< /highlight >}}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
375
376
377 

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
378
379 
## Components
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
380
381
382
383
384
385 
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.
Martijn Cuppens's avatar
Create `scss-docs` shortcode to get some snippets from the Scs… (#30502)    
Martijn Cuppens committed
386 
Here are two examples of how we loop over the `$theme-colors` map to generate modifiers to the `.alert` and `.list-group` components.
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
387
Martijn Cuppens's avatar
Create `scss-docs` shortcode to get some snippets from the Scs… (#30502)    
Martijn Cuppens committed
388 
{{< scss-docs name="alert-modifiers" file="scss/_alert.scss" >}}
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
389
Martijn Cuppens's avatar
Create `scss-docs` shortcode to get some snippets from the Scs… (#30502)    
Martijn Cuppens committed
390 
{{< scss-docs name="list-group-modifiers" file="scss/_list-group.scss" >}}
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
391
392
393 

### Responsive
Martijn Cuppens's avatar
Create `scss-docs` shortcode to get some snippets from the Scs… (#30502)    
Martijn Cuppens committed
394 
These Sass loops aren't limited to color maps, either. You can also generate responsive variations of your components. Take for example our responsive alignment of the dropdowns where we mix an `@each` loop for the `$grid-breakpoints` Sass map with a media query include.
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
395
Martijn Cuppens's avatar
Create `scss-docs` shortcode to get some snippets from the Scs… (#30502)    
Martijn Cuppens committed
396 
{{< scss-docs name="responsive-breakpoints" file="scss/_dropdown.scss" >}}
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
397
398 

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
399
400
401 

## CSS variables
Martijn Cuppens's avatar
Add `bs-` prefixes to custom properties (#30591)    
Martijn Cuppens committed
402 
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 and primary font stacks when working in your browser's Inspector, a code sandbox, or general prototyping. All our custom properties are prefixed with `bs-` to avoid conflicts with third party CSS.
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
403
404
405
406
407 

### Available variables

Here are the variables we include (note that the `:root` is required). They're located in our `_root.scss` file.
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
408 
{{< highlight css >}}
XhmikosR's avatar
theming.md: automate _root.scss. (#29326)    
XhmikosR committed
409
410
411
412 
{{< root.inline >}}
{{- $css := readFile "dist/css/bootstrap.css" -}}
{{- $match := findRE ":root {([^}]*)}" $css 1 -}}
XhmikosR's avatar
getting-started/theming.md: throw an error if the regex doesn't succeed.    
XhmikosR committed
413
414
415
416 
{{- if (eq (len $match) 0) -}}
{{- errorf "Got no matches for :root in %q!" $.Page.Path -}}
{{- end -}}
XhmikosR's avatar
theming.md: automate _root.scss. (#29326)    
XhmikosR committed
417
418
419 
{{- index $match 0 -}}

{{< /root.inline >}}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
420 
{{< /highlight >}}
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
421
422
423
424
425 

### 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.
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
426 
{{< highlight css >}}
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
427 
body {
Martijn Cuppens's avatar
Add `bs-` prefixes to custom properties (#30591)    
Martijn Cuppens committed
428 
  font: 1rem/1.5 var(--bs-font-sans-serif);
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
429
430 
}
a {
Martijn Cuppens's avatar
Add `bs-` prefixes to custom properties (#30591)    
Martijn Cuppens committed
431 
  color: var(--bs-blue);
Mark Otto's avatar
Add some documentation on using CSS vars (#25176)    
Mark Otto committed
432 
}
XhmikosR's avatar
Switch to Hugo.    
XhmikosR committed
433 
{{< /highlight >}}