Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: add shift-color() usage example in sass customization page #39435

Merged
merged 3 commits into from
Dec 12, 2023
Merged

Docs: add shift-color() usage example in sass customization page #39435

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45408e5
Docs: add `shift-color()` usage example in sass customization page
julien-deramond Nov 24, 2023
15056fd
docs: add a description of `shift-color()` function
julien-deramond Dec 12, 2023
6b5343c
Merge branch 'main' into main-jd-improve-customize-sass-colors-doc
julien-deramond Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions site/content/docs/5.3/customize/sass.md
View file
Open in desktop
louismaximepiton marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,8 @@ Next to the [Sass maps]({{< docsref "/customize/color#color-sass-maps" >}}) we h

You can lighten or darken colors with Bootstrap's `tint-color()` and `shade-color()` functions. These functions will mix colors with black or white, unlike Sass' native `lighten()` and `darken()` functions which will change the lightness by a fixed amount, which often doesn't lead to the desired effect.

`shift-color()` combines these two functions by shading the color if the weight is positive and tinting the color if the weight is negative.

{{< scss-docs name="color-functions" file="scss/_functions.scss" >}}

In practice, you'd call the function and pass in the color and weight parameters.
Expand All @@ -256,6 +258,11 @@ In practice, you'd call the function and pass in the color and weight parameters
.custom-element-2 {
color: shade-color($danger, 30%);
}

.custom-element-3 {
color: shift-color($success, 40%);
background-color: shift-color($success, -60%);
}
```

### Color contrast
Expand Down