rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-10 22:24:19 +01:00
Code Issues Actions Packages Releases Activity
37bfbcf117
Bootstrap/docs/4.0/getting-started/theming.md

320 lines
14 KiB
Markdown
Raw Normal View History

Stub out new Theming page
2017-08-22 05:27:07 +02:00
---
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
nuke the options page, add redirect from it to new theming page
2017-10-01 21:21:32 +02:00
redirect_from: "/docs/4.0/getting-started/options/"
Stub out new Theming page
2017-08-22 05:27:07 +02:00
---
## 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.
spelling changes to theming.md (#24444)
2017-10-19 19:33:31 +02:00
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.
Stub out new Theming page
2017-08-22 05:27:07 +02:00
## Sass
Utilize our source Sass files to take advantage of variables, maps, mixins, and more.
### File structure
spelling changes to theming.md (#24444)
2017-10-19 19:33:31 +02:00
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've downloaded our source files or are using a package manager, you'll have a file structure that looks like this:
Stub out new Theming page
2017-08-22 05:27:07 +02:00
{% highlight plaintext %}
your-project/
├── scss
│ └── custom.scss
└── node_modules/
└── bootstrap
├── js
└── scss
{% endhighlight %}
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
@import "node_modules/bootstrap/scss/bootstrap";
{% endhighlight %}
{% highlight scss %}
// Custom.scss
// Option B: Include parts of Bootstrap
// Required
@import "node_modules/bootstrap/scss/functions";
@import "node_modules/bootstrap/scss/variables";
@import "node_modules/bootstrap/scss/mixins";
// Optional
@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";
{% endhighlight %}
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.
### Variable defaults
port latest from options for default vars
2017-10-01 21:16:46 +02:00
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.
Stub out new Theming page
2017-08-22 05:27:07 +02:00
port latest from options for default vars
2017-10-01 21:16:46 +02:00
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:
Stub out new Theming page
2017-08-22 05:27:07 +02:00
{% highlight scss %}
port latest from options for default vars
2017-10-01 21:16:46 +02:00
// Your variable overrides
$body-bg: #000;
$body-color: #111;
// Bootstrap and its default variables
@import "node_modules/bootstrap/scss/bootstrap";
Stub out new Theming page
2017-08-22 05:27:07 +02:00
{% endhighlight %}
port latest from options for default vars
2017-10-01 21:16:46 +02:00
Repeat as necessary for any variable in Bootstrap, including the global options below.
Stub out new Theming page
2017-08-22 05:27:07 +02:00
### 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.
For example, to modify an existing color in our `$theme-colors` map, add the following to your custom Sass file:
{% highlight scss %}
$theme-colors: (
change away from vars
2017-10-03 05:43:47 +02:00
"primary": #0074d9,
"danger": #ff4136
Stub out new Theming page
2017-08-22 05:27:07 +02:00
);
{% endhighlight %}
add new thing to a map
2017-10-01 21:54:24 +02:00
To add a new color to `$theme-colors`, add the new key and value:
{% highlight scss %}
$theme-colors: (
"custom-color": #900
);
{% endhighlight %}
Stub out new Theming page
2017-08-22 05:27:07 +02:00
### Functions
functions aww yeah
2017-10-01 21:54:40 +02:00
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:
Stub out new Theming page
2017-08-22 05:27:07 +02:00
functions aww yeah
2017-10-01 21:54:40 +02:00
{% 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.
Stub out new Theming page
2017-08-22 05:27:07 +02:00
document color-yiq function
2017-10-18 03:29:47 +02:00
### Color contrast
spelling changes to theming.md (#24444)
2017-10-19 19:33:31 +02:00
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.
document color-yiq function
2017-10-18 03:29:47 +02:00
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 %}
Stub out new Theming page
2017-08-22 05:27:07 +02:00
## Sass options
port over variable options list
2017-10-01 21:20:42 +02:00
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.
You can find and customize these variables for key global options in our `_variables.scss` file.
| 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-hover-media-query` | `true` or `false` (default) | ... |
| `$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.). |
Merge branch 'dropdown-caret' of https://github.com/pat270/bootstrap into v4-dev
2017-10-03 05:51:14 +02:00
| `$enable-caret` | `true` (default) or `false` | Enables pseudo element caret on `.dropdown-toggle`. |
port over variable options list
2017-10-01 21:20:42 +02:00
| `$enable-print-styles` | `true` (default) or `false` | Enables styles for optimizing printing. |
Stub out new Theming page
2017-08-22 05:27:07 +02:00
bring over colors section
2017-10-01 21:20:58 +02:00
## Color
Stub out new Theming page
2017-08-22 05:27:07 +02:00
bring over colors section
2017-10-01 21:20:58 +02:00
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
spelling changes to theming.md (#24444)
2017-10-19 19:33:31 +02:00
All colors available in Bootstrap 4, are available as Sass variables and a Sass map in our `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.
bring over colors section
2017-10-01 21:20:58 +02:00
<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`.
{% callout info %}
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.
{% endcallout %}
### Theme colors
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 our `scss/_variables.scss` file.
<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>
Within `_variables.scss`, you'll find our color variables and Sass map. Here's an example of the `$colors` Sass map:
{% highlight scss %}
$colors: (
Update colors in _data and theming.md to match _variables.scss (#24355)
2017-10-13 12:34:27 +02:00
"blue": $blue,
"indigo": $indigo,
"purple": $purple,
"pink": $pink,
quote those to match source code
2017-10-01 21:26:02 +02:00
"red": $red,
"orange": $orange,
"yellow": $yellow,
"green": $green,
"teal": $teal,
Update colors in _data and theming.md to match _variables.scss (#24355)
2017-10-13 12:34:27 +02:00
"cyan": $cyan,
quote those to match source code
2017-10-01 21:26:02 +02:00
"white": $white,
"gray": $gray-600,
Update colors in _data and theming.md to match _variables.scss (#24355)
2017-10-13 12:34:27 +02:00
"gray-dark": $gray-800
bring over colors section
2017-10-01 21:20:58 +02:00
) !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.
Stub out new Theming page
2017-08-22 05:27:07 +02:00
## Components
add components section, remove todos
2017-10-01 22:58:09 +02:00
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.
Reference in New Issue Copy Permalink