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

Convert popovers to CSS variables

Browse Source
This commit is contained in:
Mark Otto 2021-09-08 20:18:22 -07:00 committed by Mark Otto
parent 91312486b2
commit 2e75ec3c41
5 changed files with 148 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
scss/_popover.scss
View File

@ -1,27 +1,50 @@
// stylelint-disable custom-property-empty-line-before
.popover { .popover {
// scss-docs-start popover-css-vars
--#{$variable-prefix}popover-zindex: #{$zindex-popover};
--#{$variable-prefix}popover-max-width: #{$popover-max-width};
@include rfs($popover-font-size, --#{$variable-prefix}popover-font-size);
--#{$variable-prefix}popover-bg: #{$popover-bg};
--#{$variable-prefix}popover-border-width: #{$popover-border-width};
--#{$variable-prefix}popover-border-color: #{$popover-border-color};
--#{$variable-prefix}popover-border-radius: #{$popover-border-radius};
--#{$variable-prefix}popover-box-shadow: #{$popover-box-shadow};
--#{$variable-prefix}popover-header-padding-x: #{$popover-header-padding-x};
--#{$variable-prefix}popover-header-padding-y: #{$popover-header-padding-y};
--#{$variable-prefix}popover-header-color: #{$popover-header-color};
--#{$variable-prefix}popover-header-bg: #{$popover-header-bg};
--#{$variable-prefix}popover-body-padding-x: #{$popover-body-padding-x};
--#{$variable-prefix}popover-body-padding-y: #{$popover-body-padding-y};
--#{$variable-prefix}popover-body-color: #{$popover-body-color};
--#{$variable-prefix}popover-arrow-width: #{$popover-arrow-width};
--#{$variable-prefix}popover-arrow-height: #{$popover-arrow-height};
--#{$variable-prefix}popover-arrow-border: var(--#{$variable-prefix}popover-border-color);
// scss-docs-end popover-css-vars
position: absolute; position: absolute;
top: 0; top: 0;
left: 0 #{"/* rtl:ignore */"}; left: 0 #{"/* rtl:ignore */"};
z-index: $zindex-popover; z-index: var(--#{$variable-prefix}popover-zindex);
display: block; display: block;
max-width: $popover-max-width; max-width: var(--#{$variable-prefix}popover-max-width);
// Our parent element can be arbitrary since tooltips are by default inserted as a sibling of their target element. // Our parent element can be arbitrary since tooltips are by default inserted as a sibling of their target element.
// So reset our font and text properties to avoid inheriting weird values. // So reset our font and text properties to avoid inheriting weird values.
@include reset-text(); @include reset-text();
@include font-size($popover-font-size); font-size: var(--#{$variable-prefix}popover-font-size);
// Allow breaking very long words so they don't overflow the popover's bounds // Allow breaking very long words so they don't overflow the popover's bounds
word-wrap: break-word; word-wrap: break-word;
background-color: $popover-bg; background-color: var(--#{$variable-prefix}popover-bg);
background-clip: padding-box; background-clip: padding-box;
border: $popover-border-width solid $popover-border-color; border: var(--#{$variable-prefix}popover-border-width) solid var(--#{$variable-prefix}popover-border-color);
@include border-radius($popover-border-radius); @include border-radius(var(--#{$variable-prefix}popover-border-radius));
@include box-shadow($popover-box-shadow); @include box-shadow(var(--#{$variable-prefix}popover-box-shadow));
.popover-arrow { .popover-arrow {
position: absolute; position: absolute;
display: block; display: block;
width: $popover-arrow-width; width: var(--#{$variable-prefix}popover-arrow-width);
height: $popover-arrow-height; height: var(--#{$variable-prefix}popover-arrow-height);
&::before, &::before,
&::after { &::after {
@ -30,24 +53,28 @@
content: ""; content: "";
border-color: transparent; border-color: transparent;
border-style: solid; border-style: solid;
border-width: 0;
} }
} }
} }
.bs-popover-top { .bs-popover-top {
> .popover-arrow { > .popover-arrow {
bottom: subtract(-$popover-arrow-height, $popover-border-width); bottom: calc((var(--#{$variable-prefix}popover-arrow-height)) * -1); // stylelint-disable-line function-disallowed-list
&::before,
&::after {
border-width: var(--#{$variable-prefix}popover-arrow-height) calc(var(--#{$variable-prefix}popover-arrow-width) * .5) 0; // stylelint-disable-line function-disallowed-list
}
&::before { &::before {
bottom: 0; bottom: 0;
border-width: $popover-arrow-height ($popover-arrow-width * .5) 0; border-top-color: var(--#{$variable-prefix}popover-arrow-border);
border-top-color: $popover-arrow-outer-color;
} }
&::after { &::after {
bottom: $popover-border-width; bottom: var(--#{$variable-prefix}popover-border-width);
border-width: $popover-arrow-height ($popover-arrow-width * .5) 0; border-top-color: var(--#{$variable-prefix}popover-bg);
border-top-color: $popover-arrow-color;
} }
} }
} }
@ -55,20 +82,23 @@
/* rtl:begin:ignore */ /* rtl:begin:ignore */
.bs-popover-end { .bs-popover-end {
> .popover-arrow { > .popover-arrow {
left: subtract(-$popover-arrow-height, $popover-border-width); left: calc((var(--#{$variable-prefix}popover-arrow-height)) * -1); // stylelint-disable-line function-disallowed-list
width: $popover-arrow-height; width: var(--#{$variable-prefix}popover-arrow-height);
height: $popover-arrow-width; height: var(--#{$variable-prefix}popover-arrow-width);
&::before,
&::after {
border-width: calc(var(--#{$variable-prefix}popover-arrow-width) * .5) var(--#{$variable-prefix}popover-arrow-height) calc(var(--#{$variable-prefix}popover-arrow-width) * .5) 0; // stylelint-disable-line function-disallowed-list
}
&::before { &::before {
left: 0; left: 0;
border-width: ($popover-arrow-width * .5) $popover-arrow-height ($popover-arrow-width * .5) 0; border-right-color: var(--#{$variable-prefix}popover-arrow-border);
border-right-color: $popover-arrow-outer-color;
} }
&::after { &::after {
left: $popover-border-width; left: var(--#{$variable-prefix}popover-border-width);
border-width: ($popover-arrow-width * .5) $popover-arrow-height ($popover-arrow-width * .5) 0; border-right-color: var(--#{$variable-prefix}popover-bg);
border-right-color: $popover-arrow-color;
} }
} }
} }
@ -77,18 +107,21 @@
.bs-popover-bottom { .bs-popover-bottom {
> .popover-arrow { > .popover-arrow {
top: subtract(-$popover-arrow-height, $popover-border-width); top: calc((var(--#{$variable-prefix}popover-arrow-height)) * -1); // stylelint-disable-line function-disallowed-list
&::before,
&::after {
border-width: 0 calc(var(--#{$variable-prefix}popover-arrow-width) * .5) var(--#{$variable-prefix}popover-arrow-height); // stylelint-disable-line function-disallowed-list
}
&::before { &::before {
top: 0; top: 0;
border-width: 0 ($popover-arrow-width * .5) $popover-arrow-height ($popover-arrow-width * .5); border-bottom-color: var(--#{$variable-prefix}popover-arrow-border);
border-bottom-color: $popover-arrow-outer-color;
} }
&::after { &::after {
top: $popover-border-width; top: var(--#{$variable-prefix}popover-border-width);
border-width: 0 ($popover-arrow-width * .5) $popover-arrow-height ($popover-arrow-width * .5); border-bottom-color: var(--#{$variable-prefix}popover-bg);
border-bottom-color: $popover-arrow-color;
} }
} }
@ -98,30 +131,33 @@
top: 0; top: 0;
left: 50%; left: 50%;
display: block; display: block;
width: $popover-arrow-width; width: var(--#{$variable-prefix}popover-arrow-width);
margin-left: -$popover-arrow-width * .5; margin-left: calc(var(--#{$variable-prefix}popover-arrow-width) * -.5); // stylelint-disable-line function-disallowed-list
content: ""; content: "";
border-bottom: $popover-border-width solid $popover-header-bg; border-bottom: var(--#{$variable-prefix}popover-border-width) solid var(--#{$variable-prefix}popover-header-bg);
} }
} }
/* rtl:begin:ignore */ /* rtl:begin:ignore */
.bs-popover-start { .bs-popover-start {
> .popover-arrow { > .popover-arrow {
right: subtract(-$popover-arrow-height, $popover-border-width); right: calc((var(--#{$variable-prefix}popover-arrow-height)) * -1); // stylelint-disable-line function-disallowed-list
width: $popover-arrow-height; width: var(--#{$variable-prefix}popover-arrow-height);
height: $popover-arrow-width; height: var(--#{$variable-prefix}popover-arrow-width);
&::before,
&::after {
border-width: calc(var(--#{$variable-prefix}popover-arrow-width) * .5) 0 calc(var(--#{$variable-prefix}popover-arrow-width) * .5) var(--#{$variable-prefix}popover-arrow-height); // stylelint-disable-line function-disallowed-list
}
&::before { &::before {
right: 0; right: 0;
border-width: ($popover-arrow-width * .5) 0 ($popover-arrow-width * .5) $popover-arrow-height; border-left-color: var(--#{$variable-prefix}popover-arrow-border);
border-left-color: $popover-arrow-outer-color;
} }
&::after { &::after {
right: $popover-border-width; right: var(--#{$variable-prefix}popover-border-width);
border-width: ($popover-arrow-width * .5) 0 ($popover-arrow-width * .5) $popover-arrow-height; border-left-color: var(--#{$variable-prefix}popover-bg);
border-left-color: $popover-arrow-color;
} }
} }
} }
@ -145,12 +181,12 @@
// Offset the popover to account for the popover arrow // Offset the popover to account for the popover arrow
.popover-header { .popover-header {
padding: $popover-header-padding-y $popover-header-padding-x; padding: var(--#{$variable-prefix}popover-header-padding-y) var(--#{$variable-prefix}popover-header-padding-x);
margin-bottom: 0; // Reset the default from Reboot margin-bottom: 0; // Reset the default from Reboot
@include font-size($font-size-base); @include font-size($font-size-base);
color: $popover-header-color; color: var(--#{$variable-prefix}popover-header-color);
background-color: $popover-header-bg; background-color: var(--#{$variable-prefix}popover-header-bg);
border-bottom: $popover-border-width solid $popover-border-color; border-bottom: var(--#{$variable-prefix}popover-border-width) solid var(--#{$variable-prefix}popover-border-color);
@include border-top-radius($popover-inner-border-radius); @include border-top-radius($popover-inner-border-radius);
&:empty { &:empty {
@ -159,6 +195,6 @@
} }
.popover-body { .popover-body {
padding: $popover-body-padding-y $popover-body-padding-x; padding: var(--#{$variable-prefix}popover-body-padding-y) var(--#{$variable-prefix}popover-body-padding-x);
color: $popover-body-color; color: var(--#{$variable-prefix}popover-body-color);
} }

4
scss/_tooltip.scss
View File

@ -1,3 +1,5 @@
// stylelint-disable custom-property-empty-line-before
// Base class // Base class
.tooltip { .tooltip {
// scss-docs-start tooltip-css-vars // scss-docs-start tooltip-css-vars
@ -6,7 +8,7 @@
--#{$variable-prefix}tooltip-padding-x: #{$tooltip-padding-x}; --#{$variable-prefix}tooltip-padding-x: #{$tooltip-padding-x};
--#{$variable-prefix}tooltip-padding-y: #{$tooltip-padding-y}; --#{$variable-prefix}tooltip-padding-y: #{$tooltip-padding-y};
--#{$variable-prefix}tooltip-margin: #{$tooltip-margin}; --#{$variable-prefix}tooltip-margin: #{$tooltip-margin};
--#{$variable-prefix}tooltip-font-size: #{$tooltip-font-size}; @include rfs($tooltip-font-size, --#{$variable-prefix}tooltip-font-size);
--#{$variable-prefix}tooltip-color: #{$tooltip-color}; --#{$variable-prefix}tooltip-color: #{$tooltip-color};
--#{$variable-prefix}tooltip-bg: #{$tooltip-bg}; --#{$variable-prefix}tooltip-bg: #{$tooltip-bg};
--#{$variable-prefix}tooltip-border-radius: #{$tooltip-border-radius}; --#{$variable-prefix}tooltip-border-radius: #{$tooltip-border-radius};

11
scss/_variables.scss
View File

@ -1295,7 +1295,7 @@ $tooltip-margin: 0 !default;
$tooltip-arrow-width: .8rem !default; $tooltip-arrow-width: .8rem !default;
$tooltip-arrow-height: .4rem !default; $tooltip-arrow-height: .4rem !default;
// fusv-disable // fusv-disable
$tooltip-arrow-color: null !default; // Deprecated in v5.2.0 for CSS variables $tooltip-arrow-color: null !default; // Deprecated in Bootstrap 5.2.0 for CSS variables
// fusv-enable // fusv-enable
// scss-docs-end tooltip-variables // scss-docs-end tooltip-variables
@ -1333,11 +1333,14 @@ $popover-body-padding-x: $spacer !default;
$popover-arrow-width: 1rem !default; $popover-arrow-width: 1rem !default;
$popover-arrow-height: .5rem !default; $popover-arrow-height: .5rem !default;
$popover-arrow-color: $popover-bg !default;
$popover-arrow-outer-color: fade-in($popover-border-color, .05) !default;
// scss-docs-end popover-variables // scss-docs-end popover-variables
// fusv-disable
// Deprecated in Bootstrap 5.2.0 for CSS variables
$popover-arrow-color: $popover-bg !default;
$popover-arrow-outer-color: fade-in($popover-border-color, .05) !default;
// fusv-enable
// Toasts // Toasts

11
site/assets/scss/_component-examples.scss
View File

@ -243,6 +243,17 @@
--bs-tooltip-bg: var(--bs-primary); --bs-tooltip-bg: var(--bs-primary);
} }
// scss-docs-start custom-popovers
.custom-popover {
--bs-popover-max-width: 200px;
--bs-popover-border-color: var(--bs-primary);
--bs-popover-header-bg: var(--bs-primary);
--bs-popover-header-color: var(--bs-white);
--bs-popover-body-padding-x: 1rem;
--bs-popover-body-padding-y: .5rem;
}
// scss-docs-end custom-popovers
// Scrollspy demo on fixed height div // Scrollspy demo on fixed height div
.scrollspy-example { .scrollspy-example {
position: relative; position: relative;

60
site/content/docs/5.1/components/popovers.md
View File

@ -10,7 +10,7 @@ toc: true
Things to know when using the popover plugin: Things to know when using the popover plugin:
- Popovers 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 popovers to work! - Popovers 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.
- Popovers require the [tooltip plugin]({{< docsref "/components/tooltips" >}}) as a dependency. - Popovers require the [tooltip plugin]({{< docsref "/components/tooltips" >}}) as a dependency.
- Popovers are opt-in for performance reasons, so **you must initialize them yourself**. - Popovers are opt-in for performance reasons, so **you must initialize them yourself**.
- Zero-length `title` and `content` values will never show a popover. - Zero-length `title` and `content` values will never show a popover.
@ -31,9 +31,11 @@ Things to know when using the popover plugin:
Keep reading to see how popovers work with some examples. Keep reading to see how popovers work with some examples.
## Example: Enable popovers everywhere ## Examples
One way to initialize all popovers on a page would be to select them by their `data-bs-toggle` attribute: ### Enable popovers
As mentioned above, you must initialize popovers before they can be used. One way to initialize all popovers on a page would be to select them by their `data-bs-toggle` attribute, like so:
```js ```js
var popoverTriggerList = Array.prototype.slice.call(document.querySelectorAll('[data-bs-toggle="popover"]')) var popoverTriggerList = Array.prototype.slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
@ -42,17 +44,9 @@ var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
}) })
``` ```
## Example: Using the `container` option ### Live demo
When you have some styles on a parent element that interfere with a popover, you'll want to specify a custom `container` so that the popover's HTML appears within that element instead. We use JavaScript similar to the snippet above to render the following live popover. Titles are set via `title` attribute and body content is set via `data-bs-content`.
```js
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
```
## Example
{{< example >}} {{< example >}}
<button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button> <button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
@ -60,7 +54,7 @@ var popover = new bootstrap.Popover(document.querySelector('.example-popover'),
### Four directions ### Four directions
Four options are available: top, right, bottom, and left aligned. Directions are mirrored when using Bootstrap in RTL. Four options are available: top, right, bottom, and left. Directions are mirrored when using Bootstrap in RTL. Set `data-bs-placement` to change the direction.
{{< example >}} {{< example >}}
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover"> <button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover">
@ -77,6 +71,34 @@ Four options are available: top, right, bottom, and left aligned. Directions are
</button> </button>
{{< /example >}} {{< /example >}}
### Custom `container`
When you have some styles on a parent element that interfere with a popover, you'll want to specify a custom `container` so that the popover's HTML appears within that element instead. This is common in responsive tables, input groups, and the like.
```js
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
```
### Custom popovers
<small class="d-inline-flex px-2 py-1 font-monospace text-muted border rounded-3">Added in v5.2.0</small>
You can customize the appearance of popovers using [CSS variables](#variables). We set a custom class with `data-bs-custom-class="custom-popover"` to scope our custom appearance and use it to override some of the local CSS variables.
{{< scss-docs name="custom-popovers" file="site/assets/scss/_component-examples.scss" >}}
{{< example class="custom-popover-demo" >}}
<button type="button" class="btn btn-secondary"
data-bs-toggle="popover" data-bs-placement="right"
data-bs-custom-class="custom-popover"
title="Custom popover"
data-bs-content="This popover is themed via CSS variables.">
Custom popover
</button>
{{< /example >}}
### Dismiss on next click ### Dismiss on next click
Use the `focus` trigger to dismiss popovers on the user's next click of a different element than the toggle element. Use the `focus` trigger to dismiss popovers on the user's next click of a different element than the toggle element.
@ -109,10 +131,18 @@ For disabled popover triggers, you may also prefer `data-bs-trigger="hover focus
</span> </span>
{{< /example >}} {{< /example >}}
## Sass ## CSS
### Variables ### 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, popovers now use local CSS variables on `.popover` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
{{< scss-docs name="popover-css-vars" file="scss/_popover.scss" >}}
### Sass variables
{{< scss-docs name="popover-variables" file="scss/_variables.scss" >}} {{< scss-docs name="popover-variables" file="scss/_variables.scss" >}}
## Usage ## Usage