2021-01-16 23:06:19 +01:00
---
layout: docs
title: Background
description: Convey meaning through `background-color` and add decoration with gradients.
group: utilities
toc: true
---
2023-01-21 18:51:45 +01:00
{{< callout info > }}
{{< partial " callouts / warning-color-assistive-technologies . md " > }}
{{< / callout > }}
2021-01-16 23:06:19 +01:00
## Background color
Similar to the contextual text color classes, set the background of an element to any contextual class. Background utilities **do not set `color`** , so in some cases you'll want to use `.text-*` [color utilities ]({{< docsref "/utilities/colors" >}} ).
2023-01-17 00:50:08 +01:00
{{< callout info > }}
2023-01-17 00:51:10 +01:00
Background utilities like `.bg-*` that generated from our original `$theme-colors` Sass map don't yet respond to color modes, however, any `.bg-*-subtle` utility will. This will be resolved in v6.
2023-01-17 00:50:08 +01:00
{{< / callout > }}
2021-01-16 23:06:19 +01:00
{{< example > }}
{{< colors.inline > }}
{{- range (index $.Site.Data "theme-colors") }}
< div class = "p-3 mb-2 bg-{{ .name }}{{ if .contrast_color }} text-{{ .contrast_color }}{{ else }} text-white{{ end }}" > .bg-{{ .name }}< / div >
2023-10-13 07:41:40 +02:00
< div class = "p-3 mb-2 bg-{{ .name }}-subtle text-{{ .name }}-emphasis" > .bg-{{ .name }}-subtle< / div >
2021-01-16 23:06:19 +01:00
{{- end -}}
{{< / colors.inline > }}
Add dark mode support (#35857)
* Add dark mode to docs
* Minor fix: missing space indentation
* Minor fix: revert utilities/z-index added-in modification
* Remove prev: and next: from doc because extracted to another PR
* Use .bg-body-tertiary in all Utilities > Overflow examples
* fix example
* Fix up spacing examples
* Update box-shadow Sass variables and utilities to auto-adjust to color modes
* Remove unused docs class
* Refactor form styles to use CSS variable for background images on .form-check and .form-switch
* Fix docs selector
* Rename shortcut for clarity
* Heading consistency
* Reintroduce missing 4th grid item in Utilities > Spacing example
* Fix bundlewatch
* .bd-callout* rendering is OK so removing comments in the code
* Update scss/_utilities.scss
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
* Fix gutters example styling
* Fix text colors on background utils docs
* redesign and fix up position marker example, which doesn't show nicely in darkmode but at least isn't broken
* fix some color utils examples
* Deprecate mixin notice
* Deprecate notice for list-group-item-variant() mixin
* Revamp new link CSS vars
* Use map-keys in some each Sass files
* Remove list-group-item-variant mixin ref in sass loop desc
* Display CSS vars scoped to our built-in dark mode
* Revert previous commit
* Fix list group variant link
* Fix typo
* Remove imports of alert/list-group mixins in scss/_mixins.scss
* Small formatting + comments removal in scss/_content.scss
* Fix alert links colors
* fix dropdown border-radius mixin
* fix link color and underline again, this time using CSS var override for color var and fallback value for the underline
* fix colors on docs navbar for dark mode
* remove two changes
* missing ref
* another link underline fix, just use sass vars for link decoration for now
* missing color bg docs, plus move dropdown override to scss
* more changes from review
* fix some examples, drop unused docs navbar styles, update docs navbar color mode to use mixin
* Few fixes around type
- Restored CSS variable for color on headings, this time with a fallback value
- In conjunction, restored and wrapped the default CSS var with a null value check
- Split headings and paragraphs docs in Reboot, elaborated on them
* Restyle custom details > summary element in docs
* Rewrite some migration docs
* fix form checks
* Fix up some navbar styling, tweak docs callout
* Fix select images, mostly for validation styling
* Clean up some migration notes, document some new form control CSS vars, mention new variables-dark in sass docs
* Update site/content/docs/5.2/components/scrollspy.md
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
* Apply suggestions from code review
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
* mention form control css vars in migration guide
* Tweak grid and flex docs background examples
* clarify some docs
* fix some more things
Co-authored-by: Julien Déramond <juderamond@gmail.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
2022-11-29 07:30:26 +01:00
< p class = "p-3 mb-2 bg-body-secondary" > .bg-body-secondary< / p >
< p class = "p-3 mb-2 bg-body-tertiary" > .bg-body-tertiary< / p >
< div class = "p-3 mb-2 bg-body text-body" > .bg-body< / div >
2022-11-29 08:07:27 +01:00
< div class = "p-3 mb-2 bg-black text-white" > .bg-black< / div >
2021-01-16 23:06:19 +01:00
< div class = "p-3 mb-2 bg-white text-dark" > .bg-white< / div >
Add dark mode support (#35857)
* Add dark mode to docs
* Minor fix: missing space indentation
* Minor fix: revert utilities/z-index added-in modification
* Remove prev: and next: from doc because extracted to another PR
* Use .bg-body-tertiary in all Utilities > Overflow examples
* fix example
* Fix up spacing examples
* Update box-shadow Sass variables and utilities to auto-adjust to color modes
* Remove unused docs class
* Refactor form styles to use CSS variable for background images on .form-check and .form-switch
* Fix docs selector
* Rename shortcut for clarity
* Heading consistency
* Reintroduce missing 4th grid item in Utilities > Spacing example
* Fix bundlewatch
* .bd-callout* rendering is OK so removing comments in the code
* Update scss/_utilities.scss
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
* Fix gutters example styling
* Fix text colors on background utils docs
* redesign and fix up position marker example, which doesn't show nicely in darkmode but at least isn't broken
* fix some color utils examples
* Deprecate mixin notice
* Deprecate notice for list-group-item-variant() mixin
* Revamp new link CSS vars
* Use map-keys in some each Sass files
* Remove list-group-item-variant mixin ref in sass loop desc
* Display CSS vars scoped to our built-in dark mode
* Revert previous commit
* Fix list group variant link
* Fix typo
* Remove imports of alert/list-group mixins in scss/_mixins.scss
* Small formatting + comments removal in scss/_content.scss
* Fix alert links colors
* fix dropdown border-radius mixin
* fix link color and underline again, this time using CSS var override for color var and fallback value for the underline
* fix colors on docs navbar for dark mode
* remove two changes
* missing ref
* another link underline fix, just use sass vars for link decoration for now
* missing color bg docs, plus move dropdown override to scss
* more changes from review
* fix some examples, drop unused docs navbar styles, update docs navbar color mode to use mixin
* Few fixes around type
- Restored CSS variable for color on headings, this time with a fallback value
- In conjunction, restored and wrapped the default CSS var with a null value check
- Split headings and paragraphs docs in Reboot, elaborated on them
* Restyle custom details > summary element in docs
* Rewrite some migration docs
* fix form checks
* Fix up some navbar styling, tweak docs callout
* Fix select images, mostly for validation styling
* Clean up some migration notes, document some new form control CSS vars, mention new variables-dark in sass docs
* Update site/content/docs/5.2/components/scrollspy.md
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
* Apply suggestions from code review
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
* mention form control css vars in migration guide
* Tweak grid and flex docs background examples
* clarify some docs
* fix some more things
Co-authored-by: Julien Déramond <juderamond@gmail.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
2022-11-29 07:30:26 +01:00
< div class = "p-3 mb-2 bg-transparent text-body" > .bg-transparent< / div >
2021-01-16 23:06:19 +01:00
{{< / example > }}
## Background gradient
By adding a `.bg-gradient` class, a linear gradient is added as background image to the backgrounds. This gradient starts with a semi-transparent white which fades out to the bottom.
Do you need a gradient in your custom CSS? Just add `background-image: var(--bs-gradient);` .
{{< markdown > }}
{{< colors.inline > }}
{{- range (index $.Site.Data "theme-colors") }}
< div class = "p-3 mb-2 bg-{{ .name }} bg-gradient{{ with .contrast_color }} text-{{ . }}{{ else }} text-white{{ end }}" > .bg-{{ .name }}.bg-gradient< / div >
{{- end -}}
{{< / colors.inline > }}
2022-11-29 08:07:27 +01:00
< div class = "p-3 mb-2 bg-black bg-gradient text-white" > .bg-black.bg-gradient< / div >
2021-01-16 23:06:19 +01:00
{{< / markdown > }}
2021-05-24 20:56:19 +02:00
## Opacity
2022-03-12 06:27:58 +01:00
{{< added-in " 5 . 1 . 0 " > }}
2021-05-24 20:56:19 +02:00
As of v5.1.0, `background-color` utilities are generated with Sass using CSS variables. This allows for real-time color changes without compilation and dynamic alpha transparency changes.
### How it works
Consider our default `.bg-success` utility.
```css
.bg-success {
--bs-bg-opacity: 1;
background-color: rgba(var(--bs-success-rgb), var(--bs-bg-opacity)) !important;
}
```
2021-07-19 05:39:02 +02:00
We use an RGB version of our `--bs-success` (with the value of `25, 135, 84` ) CSS variable and attached a second CSS variable, `--bs-bg-opacity` , for the alpha transparency (with a default value `1` thanks to a local CSS variable). That means anytime you use `.bg-success` now, your computed `color` value is `rgba(25, 135, 84, 1)` . The local CSS variable inside each `.bg-*` class avoids inheritance issues so nested instances of the utilities don't automatically have a modified alpha transparency.
2021-05-24 20:56:19 +02:00
### Example
To change that opacity, override `--bs-bg-opacity` via custom styles or inline styles.
{{< example > }}
< div class = "bg-success p-2 text-white" > This is default success background< / div >
< div class = "bg-success p-2" style = "--bs-bg-opacity: .5;" > This is 50% opacity success background< / div >
{{< / example > }}
Or, choose from any of the `.bg-opacity` utilities:
{{< example > }}
< div class = "bg-success p-2 text-white" > This is default success background< / div >
< div class = "bg-success p-2 text-white bg-opacity-75" > This is 75% opacity success background< / div >
< div class = "bg-success p-2 text-dark bg-opacity-50" > This is 50% opacity success background< / div >
< div class = "bg-success p-2 text-dark bg-opacity-25" > This is 25% opacity success background< / div >
< div class = "bg-success p-2 text-dark bg-opacity-10" > This is 10% opacity success background< / div >
{{< / example > }}
2023-01-17 03:57:24 +01:00
## CSS
2021-01-16 23:06:19 +01:00
In addition to the following Sass functionality, consider reading about our included [CSS custom properties ]({{< docsref "/customize/css-variables" >}} ) (aka CSS variables) for colors and more.
2023-01-17 03:57:24 +01:00
### Sass variables
2021-01-16 23:06:19 +01:00
Most `background-color` utilities are generated by our theme colors, reassigned from our generic color palette variables.
{{< scss-docs name = "color-variables" file = "scss/_variables.scss" > }}
{{< scss-docs name = "theme-color-variables" file = "scss/_variables.scss" > }}
{{< scss-docs name = "variable-gradient" file = "scss/_variables.scss" > }}
Grayscale colors are also available, but only a subset are used to generate any utilities.
{{< scss-docs name = "gray-color-variables" file = "scss/_variables.scss" > }}
2023-01-17 03:57:24 +01:00
Variables for setting `background-color` in `.bg-*-subtle` utilities in light and dark mode:
{{< scss-docs name = "theme-bg-subtle-variables" file = "scss/_variables.scss" > }}
{{< scss-docs name = "theme-bg-subtle-dark-variables" file = "scss/_variables-dark.scss" > }}
### Sass maps
2021-01-16 23:06:19 +01:00
Theme colors are then put into a Sass map so we can loop over them to generate our utilities, component modifiers, and more.
{{< scss-docs name = "theme-colors-map" file = "scss/_variables.scss" > }}
Grayscale colors are also available as a Sass map. **This map is not used to generate any utilities.**
{{< scss-docs name = "gray-colors-map" file = "scss/_variables.scss" > }}
2021-05-24 20:56:19 +02:00
RGB colors are generated from a separate Sass map:
2021-11-15 12:03:48 +01:00
{{< scss-docs name = "theme-colors-rgb" file = "scss/_maps.scss" > }}
2021-05-24 20:56:19 +02:00
2023-01-17 03:57:24 +01:00
Background color opacities build on that with their own map that's consumed by the utilities API:
2021-05-24 20:56:19 +02:00
2021-11-15 12:03:48 +01:00
{{< scss-docs name = "utilities-bg-colors" file = "scss/_maps.scss" > }}
2021-05-24 20:56:19 +02:00
2023-01-17 03:57:24 +01:00
Color mode background colors are also available as a Sass map:
{{< scss-docs name = "theme-bg-subtle-map" file = "scss/_maps.scss" > }}
{{< scss-docs name = "theme-bg-subtle-dark-map" file = "scss/_maps.scss" > }}
### Sass mixins
2021-01-16 23:06:19 +01:00
**No mixins are used to generate our background utilities**, but we do have some additional mixins for other situations where you'd like to create your own gradients.
{{< scss-docs name = "gradient-bg-mixin" file = "scss/mixins/_gradients.scss" > }}
{{< scss-docs name = "gradient-mixins" file = "scss/mixins/_gradients.scss" > }}
2023-04-10 17:53:28 +02:00
### Sass utilities API
2021-01-16 23:06:19 +01:00
Background utilities are declared in our utilities API in `scss/_utilities.scss` . [Learn how to use the utilities API. ]({{< docsref "/utilities/api#using-the-api" >}} )
{{< scss-docs name = "utils-bg-color" file = "scss/_utilities.scss" > }}