弹出提示窗口

将 Bootstrap 弹出窗口（如 iOS 中的弹出窗口）添加到您网站上的任何元素的文档和示例。

在此页

概述

使用 popover 插件时的注意事项：

Popovers依赖第三方库Popper进行定位。你必须在bootstrap.js之前包含popper.min.js，或者使用一个包含 Popper 的bootstrap.bundle.min.js。
Popovers 需要popover 插件作为依赖项。
出于性能原因，弹出窗口是可选的，因此您必须自己初始化它们。
零长度title和content值永远不会显示弹出窗口。
指定container: 'body'以避免在更复杂的组件（如我们的输入组、按钮组等）中出现渲染问题。
在隐藏元素上触发弹出窗口将不起作用。
.disabled或disabled元素的弹出窗口必须在包装元素上触发。
当从多行文本的锚点触发时，弹出窗口将在锚点的总宽度之间居中。在你的<a>上使用.text-nowrap以避免这种行为。
在从 DOM 中删除相应的元素之前，必须隐藏弹出窗口。
影子 DOM 中的元素，可以触发弹出窗口。

默认情况下，此组件使用内置的内容清理器，它会去除任何未明确允许的 HTML 元素。有关更多详细信息，请参阅我们的 JavaScript 文档中的Sanitizer部分。

该组件的动画效果依赖于prefers-reduced-motion媒体查询。请参阅我们的辅助功能文档的减少运动部分。

继续阅读以了解弹出窗口如何使用一些示例。

例子

启用弹出窗口

如上所述，您必须先初始化弹出窗口才能使用它们。初始化页面上所有弹出窗口的一种方法是通过data-bs-toggle属性选择它们，如下所示：

const popoverTriggerList = document.querySelectorAll('[data-bs-toggle="popover"]')
const popoverList = [...popoverTriggerList].map(popoverTriggerEl => new bootstrap.Popover(popoverTriggerEl))

示例

我们使用类似于上面代码片段的 JavaScript 来呈现以下实时弹出窗口。data-bs-title设置标题，data-bs-content设置正文内容。

在您的 HTML 中请随意使用title或data-bs-title。当使用title时，Popper 会在渲染元素时自动用data-bs-title替换它。

HTML

<button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" data-bs-title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>

四个方向

有四个选项可用：顶部、右侧、底部和左侧。在 RTL 中使用 Bootstrap 时，方向会被镜像。设置data-bs-placement改变方向。

HTML

<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover">
  Popover on top
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="right" data-bs-content="Right popover">
  Popover on right
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-content="Bottom popover">
  Popover on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover">
  Popover on left
</button>

自定义`container`

当您的父元素上有一些样式会干扰弹出框时，您需要指定一个自定义样式，container以便弹出框的 HTML 显示在该元素中。这在响应表、输入组等中很常见。

const popover = new bootstrap.Popover('.example-popover', {
  container: 'body'
})

Another situation where you’ll want to set an explicit custom container are popovers inside a modal dialog, to make sure that the popover itself is appended to the modal. This is particularly important for popovers that contain interactive elements – modal dialogs will trap focus, so unless the popover is a child element of the modal, users won’t be able to focus or activate these interactive elements.

const popover = new bootstrap.Popover('.example-popover', {
  container: '.modal-body'
})

自定义弹出框

Added in v5.2.0

You can customize the appearance of popovers using CSS 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.

.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;
}

html

<button type="button" class="btn btn-secondary"
        data-bs-toggle="popover" data-bs-placement="right"
        data-bs-custom-class="custom-popover"
        data-bs-title="Custom popover"
        data-bs-content="This popover is themed via CSS variables.">
  Custom popover
</button>

下次点击时关闭

Use the focus trigger to dismiss popovers on the user’s next click of a different element than the toggle element.

Specific markup required for dismiss-on-next-click

For proper cross-browser and cross-platform behavior, you must use the <a> tag, not the <button> tag, and you also must include a tabindex attribute.

Dismissible popover

html

<a tabindex="0" class="btn btn-lg btn-danger" role="button" data-bs-toggle="popover" data-bs-trigger="focus" data-bs-title="Dismissible popover" data-bs-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>

const popover = new bootstrap.Popover('.popover-dismiss', {
  trigger: 'focus'
})

禁用元素

Elements with the disabled attribute aren’t interactive, meaning users cannot hover or click them to trigger a popover (or tooltip). As a workaround, you’ll want to trigger the popover from a wrapper <div> or <span>, ideally made keyboard-focusable using tabindex="0".

For disabled popover triggers, you may also prefer data-bs-trigger="hover focus" so that the popover appears as immediate visual feedback to your users as they may not expect to click on a disabled element.

html

<span class="d-inline-block" tabindex="0" data-bs-toggle="popover" data-bs-trigger="hover focus" data-bs-content="Disabled popover">
  <button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

CSS

Variables

Added in v5.2.0

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.

  --#{$prefix}popover-zindex: #{$zindex-popover};
  --#{$prefix}popover-max-width: #{$popover-max-width};
  @include rfs($popover-font-size, --#{$prefix}popover-font-size);
  --#{$prefix}popover-bg: #{$popover-bg};
  --#{$prefix}popover-border-width: #{$popover-border-width};
  --#{$prefix}popover-border-color: #{$popover-border-color};
  --#{$prefix}popover-border-radius: #{$popover-border-radius};
  --#{$prefix}popover-inner-border-radius: #{$popover-inner-border-radius};
  --#{$prefix}popover-box-shadow: #{$popover-box-shadow};
  --#{$prefix}popover-header-padding-x: #{$popover-header-padding-x};
  --#{$prefix}popover-header-padding-y: #{$popover-header-padding-y};
  @include rfs($popover-header-font-size, --#{$prefix}popover-header-font-size);
  --#{$prefix}popover-header-color: #{$popover-header-color};
  --#{$prefix}popover-header-bg: #{$popover-header-bg};
  --#{$prefix}popover-body-padding-x: #{$popover-body-padding-x};
  --#{$prefix}popover-body-padding-y: #{$popover-body-padding-y};
  --#{$prefix}popover-body-color: #{$popover-body-color};
  --#{$prefix}popover-arrow-width: #{$popover-arrow-width};
  --#{$prefix}popover-arrow-height: #{$popover-arrow-height};
  --#{$prefix}popover-arrow-border: var(--#{$prefix}popover-border-color);

Sass variables

$popover-font-size:                 $font-size-sm;
$popover-bg:                        var(--#{$prefix}body-bg);
$popover-max-width:                 276px;
$popover-border-width:              var(--#{$prefix}border-width);
$popover-border-color:              var(--#{$prefix}border-color-translucent);
$popover-border-radius:             var(--#{$prefix}border-radius-lg);
$popover-inner-border-radius:       calc($popover-border-radius - $popover-border-width); // stylelint-disable-line function-disallowed-list
$popover-box-shadow:                $box-shadow;

$popover-header-font-size:          $font-size-base;
$popover-header-bg:                 var(--#{$prefix}secondary-bg);
$popover-header-color:              $headings-color;
$popover-header-padding-y:          .5rem;
$popover-header-padding-x:          $spacer;

$popover-body-color:                var(--#{$prefix}body-color);
$popover-body-padding-y:            $spacer;
$popover-body-padding-x:            $spacer;

$popover-arrow-width:               1rem;
$popover-arrow-height:              .5rem;

Usage

Enable popovers via JavaScript:

const exampleEl = document.getElementById('example')
const popover = new bootstrap.Popover(exampleEl, options)

Making popovers work for keyboard and assistive technology users

To allow keyboard users to activate your popovers, you should only add them to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as <span>s) can be made focusable by adding the tabindex="0" attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users, and most assistive technologies currently do not announce the popover’s content in this situation. Additionally, do not rely solely on hover as the trigger for your popovers, as this will make them impossible to trigger for keyboard users.

While you can insert rich, structured HTML in popovers with the html option, we strongly recommend that you avoid adding an excessive amount of content. The way popovers currently work is that, once displayed, their content is tied to the trigger element with the aria-describedby attribute. As a result, the entirety of the popover’s content will be announced to assistive technology users as one long, uninterrupted stream.

Additionally, while it is possible to also include interactive controls (such as form elements or links) in your popover (by adding these elements to the allowList of allowed attributes and tags), be aware that currently the popover does not manage keyboard focus order. When a keyboard user opens a popover, focus remains on the triggering element, and as the popover usually does not immediately follow the trigger in the document’s structure, there is no guarantee that moving forward/pressing Tab will move a keyboard user into the popover itself. In short, simply adding interactive controls to a popover is likely to make these controls unreachable/unusable for keyboard users and users of assistive technologies, or at the very least make for an illogical overall focus order. In these cases, consider using a modal dialog instead.

Options

As options can be passed via data attributes or JavaScript, you can append an option name to data-bs-, as in data-bs-animation="{value}". Make sure to change the case type of the option name from “camelCase” to “kebab-case” when passing the options via data attributes. For example, use data-bs-custom-class="beautifier" instead of data-bs-customClass="beautifier".

As of Bootstrap 5.2.0, all components support an experimental reserved data attribute data-bs-config that can house simple component configuration as a JSON string. When an element has data-bs-config='{"delay":0, "title":123}' and data-bs-title="456" attributes, the final title value will be 456 and the separate data attributes will override values given on data-bs-config. In addition, existing data attributes are able to house JSON values like data-bs-delay='{"show":0,"hide":150}'.

Note that for security reasons the sanitize, sanitizeFn, and allowList options cannot be supplied using data attributes.

Name	Type	Default	Description
`allowList`	object	Default value	Object which contains allowed attributes and tags.
`animation`	boolean	`true`	Apply a CSS fade transition to the popover.
`boundary`	string, element	`'clippingParents'`	Overflow constraint boundary of the popover (applies only to Popper’s preventOverflow modifier). By default, it’s `'clippingParents'` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper’s detectOverflow docs.
`container`	string, element, false	`false`	Appends the popover to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.
`content`	string, element, function	`''`	Default content value if `data-bs-content` attribute isn’t present. If a function is given, it will be called with its `this` reference set to the element that the popover is attached to.
`customClass`	string, function	`''`	Add classes to the popover when it is shown. Note that these classes will be added in addition to any classes specified in the template. To add multiple classes, separate them with spaces: `'class-1 class-2'`. You can also pass a function that should return a single string containing additional class names.
`delay`	number, object	`0`	Delay showing and hiding the popover (ms)—doesn’t apply to manual trigger type. If a number is supplied, delay is applied to both hide/show. Object structure is: `delay: { "show": 500, "hide": 100 }`.
`fallbackPlacements`	string, array	`['top', 'right', 'bottom', 'left']`	Define fallback placements by providing a list of placements in array (in order of preference). For more information refer to Popper’s behavior docs.
`html`	boolean	`false`	Allow HTML in the popover. If true, HTML tags in the popover’s `title` will be rendered in the popover. If false, `innerText` property will be used to insert content into the DOM. Use text if you’re worried about XSS attacks.
`offset`	number, string, function	`[0, 0]`	Offset of the popover relative to its target. You can pass a string in data attributes with comma separated values like: `data-bs-offset="10,20"`. When a function is used to determine the offset, it is called with an object containing the popper placement, the reference, and popper rects as its first argument. The triggering element DOM node is passed as the second argument. The function must return an array with two numbers: skidding, distance. For more information refer to Popper’s offset docs.
`placement`	string, function	`'top'`	How to position the popover: auto, top, bottom, left, right. When `auto` is specified, it will dynamically reorient the popover. When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The `this` context is set to the popover instance.
`popperConfig`	null, object, function	`null`	To change Bootstrap’s default Popper config, see Popper’s configuration. When a function is used to create the Popper configuration, it’s called with an object that contains the Bootstrap’s default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper.
`sanitize`	boolean	`true`	Enable or disable the sanitization. If activated `'template'`, `'content'` and `'title'` options will be sanitized.
`sanitizeFn`	null, function	`null`	Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.
`selector`	string, false	`false`	If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to also apply popovers to dynamically added DOM elements (`jQuery.on` support). See this issue and an informative example. Note: `title` attribute must not be used as a selector.
`template`	string	`'<div class="popover" role="popover"><div class="popover-arrow"></div><div class="popover-inner"></div></div>'`	Base HTML to use when creating the popover. The popover’s `title` will be injected into the `.popover-inner`. `.popover-arrow` will become the popover’s arrow. The outermost wrapper element should have the `.popover` class and `role="popover"`.
`title`	string, element, function	`''`	Default title value if `title` attribute isn’t present. If a function is given, it will be called with its `this` reference set to the element that the popover is attached to.
`trigger`	string	`'hover focus'`	How popover is triggered: click, hover, focus, manual. You may pass multiple triggers; separate them with a space. `'manual'` indicates that the popover will be triggered programmatically via the `.popover('show')`, `.popover('hide')` and `.popover('toggle')` methods; this value cannot be combined with any other trigger. `'hover'` on its own will result in popovers that cannot be triggered via the keyboard, and should only be used if alternative methods for conveying the same information for keyboard users is present.

Data attributes for individual popovers

Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.

Using function with `popperConfig`

const popover = new bootstrap.Popover(element, {
  popperConfig(defaultBsPopperConfig) {
    // const newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})

Methods

Asynchronous methods and transitions

All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.

See our JavaScript documentation for more information.

Method	Description
`disable`	Removes the ability for an element’s popover to be shown. The popover will only be able to be shown if it is re-enabled.
`dispose`	Hides and destroys an element’s popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using the `selector` option) cannot be individually destroyed on descendant trigger elements.
`enable`	Gives an element’s popover the ability to be shown. Popovers are enabled by default.
`getInstance`	Static method which allows you to get the popover instance associated with a DOM element.
`getOrCreateInstance`	Static method which allows you to get the popover instance associated with a DOM element, or create a new one in case it wasn’t initialized.
`hide`	Hides an element’s popover. Returns to the caller before the popover has actually been hidden (i.e. before the `hidden.bs.popover` event occurs). This is considered a “manual” triggering of the popover.
`setContent`	Gives a way to change the popover’s content after its initialization.
`show`	Reveals an element’s popover. Returns to the caller before the popover has actually been shown (i.e. before the `shown.bs.popover` event occurs). This is considered a “manual” triggering of the popover. Popovers whose title and content are both zero-length are never displayed.
`toggle`	Toggles an element’s popover. Returns to the caller before the popover has actually been shown or hidden (i.e. before the `shown.bs.popover` or `hidden.bs.popover` event occurs). This is considered a “manual” triggering of the popover.
`toggleEnabled`	Toggles the ability for an element’s popover to be shown or hidden.
`update`	Updates the position of an element’s popover.

// getOrCreateInstance example
const popover = bootstrap.Popover.getOrCreateInstance('#example') // Returns a Bootstrap popover instance

// setContent example
myPopover.setContent({
  '.popover-header': 'another title',
  '.popover-body': 'another content'
})

该setContent方法接受一个object参数，其中每个属性键都是string弹出框模板中的有效选择器，并且每个相关的属性值可以是string| element| function|null

事件

事件	描述
`hide.bs.popover`	`hide`调用实例方法时会立即触发此事件。
`hidden.bs.popover`	当弹出框完成对用户隐藏时（将等待 CSS 转换完成），将触发此事件。
`inserted.bs.popover`	`show.bs.popover`当 popover 模板被添加到 DOM 时，该事件将在该事件之后触发。
`show.bs.popover`	`show`调用实例方法时会立即触发此事件。
`shown.bs.popover`	当弹出窗口对用户可见时会触发此事件（将等待 CSS 转换完成）。

const myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', () => {
  // do something...
})

弹出提示窗口

概述

例子

启用弹出窗口

示例

四个方向

自定义container

自定义弹出框

下次点击时关闭

Specific markup required for dismiss-on-next-click

禁用元素

CSS

Variables

Sass variables

Usage

Making popovers work for keyboard and assistive technology users

Options

Data attributes for individual popovers

Using function with popperConfig

Methods

Asynchronous methods and transitions

事件

自定义`container`

Using function with `popperConfig`