diff options
| author | Mark Otto <[email protected]> | 2021-09-08 11:01:35 -0700 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2021-09-08 20:20:49 -0700 |
| commit | c45db4c104b9196a7edb511b6062cf5464abf2c0 (patch) | |
| tree | dee4f9e7557a3864955c929fc2adcbca640a2334 | |
| parent | 3fcc7cdb41639284c00616ff03a2ba550fbc7113 (diff) | |
| download | bootstrap-c45db4c104b9196a7edb511b6062cf5464abf2c0.tar.xz bootstrap-c45db4c104b9196a7edb511b6062cf5464abf2c0.zip | |
Document new CSS vars in tooltip docs
| -rw-r--r-- | scss/_tooltip.scss | 2 | ||||
| -rw-r--r-- | site/content/docs/5.1/components/tooltips.md | 22 |
2 files changed, 18 insertions, 6 deletions
diff --git a/scss/_tooltip.scss b/scss/_tooltip.scss index d2b64a72a..9863f8bfd 100644 --- a/scss/_tooltip.scss +++ b/scss/_tooltip.scss @@ -1,5 +1,6 @@ // Base class .tooltip { + // scss-docs-start tooltip-css-vars --#{$variable-prefix}tooltip-padding: #{$tooltip-padding-y} #{$tooltip-padding-x}; --#{$variable-prefix}tooltip-font-size: #{$tooltip-font-size}; --#{$variable-prefix}tooltip-color: #{$tooltip-color}; @@ -8,6 +9,7 @@ --#{$variable-prefix}tooltip-opacity: #{$tooltip-opacity}; --#{$variable-prefix}tooltip-arrow-width: #{$tooltip-arrow-width}; --#{$variable-prefix}tooltip-arrow-height: #{$tooltip-arrow-height}; + // scss-docs-end tooltip-css-vars $tooltip-arrow-color: null; diff --git a/site/content/docs/5.1/components/tooltips.md b/site/content/docs/5.1/components/tooltips.md index 246747251..a0c47f0e8 100644 --- a/site/content/docs/5.1/components/tooltips.md +++ b/site/content/docs/5.1/components/tooltips.md @@ -10,7 +10,7 @@ toc: true Things to know when using the tooltip plugin: -- Tooltips rely on the 3rd party library [Popper](https://popper.js.org/) for positioning. You must include [popper.min.js]({{< param "cdn.popper" >}}) before bootstrap.js or use `bootstrap.bundle.min.js` / `bootstrap.bundle.js` which contains Popper in order for tooltips to work! +- Tooltips rely on the third party library [Popper](https://popper.js.org/) for positioning. You must include [popper.min.js]({{< param "cdn.popper" >}}) before `bootstrap.js`, or use one `bootstrap.bundle.min.js` which contains Popper. - Tooltips are opt-in for performance reasons, so **you must initialize them yourself**. - Tooltips with zero-length titles are never displayed. - Specify `container: 'body'` to avoid rendering problems in more complex components (like our input groups, button groups, etc). @@ -20,6 +20,8 @@ Things to know when using the tooltip plugin: - Tooltips must be hidden before their corresponding elements have been removed from the DOM. - Tooltips can be triggered thanks to an element inside a shadow DOM. +Got all that? Great, let's see how they work with some examples. + {{< callout info >}} {{< partial "callout-info-sanitizer.md" >}} {{< /callout >}} @@ -28,11 +30,11 @@ Things to know when using the tooltip plugin: {{< partial "callout-info-prefersreducedmotion.md" >}} {{< /callout >}} -Got all that? Great, let's see how they work with some examples. +## Examples -## Example: Enable tooltips everywhere +### Enable tooltips -One way to initialize all tooltips on a page would be to select them by their `data-bs-toggle` attribute: +As mentioned above, you must initialize tooltips before they can be used. One way to initialize all tooltips on a page would be to select them by their `data-bs-toggle` attribute, like so: ```js var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]')) @@ -41,7 +43,7 @@ var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) { }) ``` -## Examples +### Toolips on links Hover over the links below to see tooltips: @@ -119,10 +121,18 @@ With an SVG: </a> </div> -## Sass +## CSS ### Variables +<small class="d-inline-flex px-2 py-1 font-monospace text-muted border rounded-3">Added in v5.2.0</small> + +As part of Bootstrap’s evolving CSS variables approach, tooltips now use local CSS variables on `.tooltip` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too. + +{{< scss-docs name="tooltip-css-vars" file="scss/_tooltip.scss" >}} + +### Sass variables + {{< scss-docs name="tooltip-variables" file="scss/_variables.scss" >}} ## Usage |
