Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
theming.md 17.9 KB
Newer Older
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
1
2
3
4
5
6 
---
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
Mark Otto's avatar
Ship v4.1.0 (#26218)    
Mark Otto committed
7 
redirect_from: "/docs/4.1/getting-started/options/"
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
8
9
10
11
12
13 
---

## 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
14 
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
15
16
17
18
19
20
21 

## Sass

Utilize our source Sass files to take advantage of variables, maps, mixins, and more.

### File structure
Mark Otto's avatar
fixes #24728    
Mark Otto committed
22 
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
23
24
25
26
27
28
29
30
31
32
33 

{% highlight plaintext %}
your-project/
├── scss
│   └── custom.scss
└── node_modules/
    └── bootstrap
        ├── js
        └── scss
{% endhighlight %}
Mark Otto's avatar
fixes #24728    
Mark Otto committed
34
35
36
37
38
39
40
41
42
43
44 
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
45
46 
### Importing
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
47
48
49
50
51
52 
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
53 
@import "../node_modules/bootstrap/scss/bootstrap";
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
54
55
56
57
58
59
60 
{% endhighlight %}

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

// Required
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
61
62
63 
@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
64
65 

// Optional
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
66
67
68
69
70 
@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
71
72 
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
73 
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
74
75
76 

### Variable defaults
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
77 
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
78
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
79
80 
You will find the complete list of Bootstrap's variables in `scss/_variables.scss`.
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
81
82
83 
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
84
85 

{% highlight scss %}
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
86
87
88
89
90 
// 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
91 
@import "../node_modules/bootstrap/scss/bootstrap";
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
92
93 
{% endhighlight %}
Mark Otto's avatar
port latest from options for default vars    
Mark Otto committed
94 
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
95
96
97
98
99 

### 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
100
101 
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
102
103 
#### Modify map
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
104 
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
105
106
107 

{% highlight scss %}
$theme-colors: (
Mark Otto's avatar
change away from vars    
Mark Otto committed
108
109 
  "primary": #0074d9,
  "danger": #ff4136
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
110
111
112 
);
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
113
114 
#### Add to map
Mark Otto's avatar
add new thing to a map    
Mark Otto committed
115
116
117
118
119
120
121 
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
122
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
123
124 
#### Remove from map
ysds's avatar
Update themeing docs for more clearly how to remove from map (#25589)    
ysds committed
125 
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
126
127 

{% highlight scss %}
ysds's avatar
Update themeing docs for more clearly how to remove from map (#25589)    
ysds committed
128 
// Required
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
129
130
131 
@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
132
133
134
135 

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

// Optional
Martijn Cuppens's avatar
Fix node_modules path (#26653)    
Martijn Cuppens committed
136
137
138 
@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
139 
...
Mark Otto's avatar
Update Theming docs for removing map items (#25108)    
Mark Otto committed
140
141 
{% endhighlight %}
Mark Otto's avatar
Theming docs update (#25300)    
Mark Otto committed
142
143
144
145
146
147 
#### 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
148
149 
### Functions
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
150 
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
151
Mark Otto's avatar
functions aww yeah    
Mark Otto committed
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
195 
{% 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
196
Mark Otto's avatar
document color-yiq function    
Mark Otto committed
197
198 
### Color contrast
Gijs Boddeus's avatar
spelling changes to theming.md (#24444)    
Gijs Boddeus committed
199 
One 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
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
226 

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 %}
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
227
228 
## Sass options
Mark Otto's avatar
port over variable options list    
Mark Otto committed
229
230 
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
231 
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
232
233
234
235 

| 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/). |
Mark Otto's avatar
Deprecate hover media query shim and mixins (#25270)    
Mark Otto committed
236
237
238
239
240
241
242
243 
| `$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-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-print-styles`      | `true` (default) or `false`        | Enables styles for optimizing printing. |
Mark Otto's avatar
Restore feedback icons on validated form fields    
Mark Otto committed
244 
| `$enable-validation-icons`  | `true` (default) or `false`        | Enables `background-image` icons within textual inputs and some custom forms for validation states. |
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
245
Mark Otto's avatar
bring over colors section    
Mark Otto committed
246 
## Color
Mark Otto's avatar
Stub out new Theming page  
Mark Otto committed
247
Mark Otto's avatar
bring over colors section    
Mark Otto committed
248
249
250
251 
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
252 
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275 

<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
276 
{% capture callout %}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
277 
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
278
279 
{% endcapture %}
{% include callout.html content=callout type="info" %}
Mark Otto's avatar
bring over colors section    
Mark Otto committed
280
281
282 

### Theme colors
Pierre GIRAUD's avatar
Be more explicit where to find variables (#25624)    
Pierre GIRAUD committed
283 
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 Bootstraps's `scss/_variables.scss` file.
Mark Otto's avatar
bring over colors section    
Mark Otto committed
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304 

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

### Grays

An expansive set of gray variables and a Sass map in `scss/_variables.scss` for consistent shades of gray across your project.

<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
305 
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
306
307
308 

{% highlight scss %}
$colors: (
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
309
310
311
312 
  "blue": $blue,
  "indigo": $indigo,
  "purple": $purple,
  "pink": $pink,
Mark Otto's avatar
quote those to match source code    
Mark Otto committed
313
314
315
316
317 
  "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
318 
  "cyan": $cyan,
Mark Otto's avatar
quote those to match source code    
Mark Otto committed
319
320 
  "white": $white,
  "gray": $gray-600,
Jesse Mandel's avatar
Update colors in _data and theming.md to match _variables.scss (#24355)    
Jesse Mandel committed
321 
  "gray-dark": $gray-800
Mark Otto's avatar
bring over colors section    
Mark Otto committed
322
323
324
325
326 
) !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
327
328 
## Components
Mark Otto's avatar
add components section, remove todos    
Mark Otto committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367 
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
368
369
370 

## CSS variables
Ethan Beyer's avatar
theming.md Typo Fix (#25875)    
Ethan Beyer committed
371 
Bootstrap 4 includes around two dozen [CSS custom properties (variables)](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) 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
372
373
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
413
414
415
416
417
418
419
420
421
422 

### 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;
  --font-family-sans-serif: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
  --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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443 
### Breakpoint variables

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)

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 %}