mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-13 01:08:58 +01:00
357 lines
15 KiB
Markdown
357 lines
15 KiB
Markdown
---
|
||
layout: docs
|
||
title: Tooltips
|
||
description: Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage.
|
||
group: components
|
||
toc: true
|
||
---
|
||
|
||
## Overview
|
||
|
||
Things to know when using the tooltip plugin:
|
||
|
||
- Tooltips rely on the 3rd party library [Popper.js](https://popper.js.org/) for positioning. You must include [popper.min.js]({{ site.cdn.popper }}) before bootstrap.js or use `bootstrap.bundle.min.js` / `bootstrap.bundle.js` which contains Popper.js in order for tooltips to work!
|
||
- If you're building our JavaScript from source, it [requires `util.js`]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/javascript/#util).
|
||
- 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).
|
||
- Triggering tooltips on hidden elements will not work.
|
||
- Tooltips for `.disabled` or `disabled` elements must be triggered on a wrapper element.
|
||
- When triggered from hyperlinks that span multiple lines, tooltips will be centered. Use `white-space: nowrap;` on your `<a>`s to avoid this behavior.
|
||
- Tooltips must be hidden before their corresponding elements have been removed from the DOM.
|
||
|
||
Got all that? Great, let's see how they work with some examples.
|
||
|
||
## Example: Enable tooltips everywhere
|
||
|
||
One way to initialize all tooltips on a page would be to select them by their `data-toggle` attribute:
|
||
|
||
{% highlight js %}
|
||
$(function () {
|
||
$('[data-toggle="tooltip"]').tooltip()
|
||
})
|
||
{% endhighlight %}
|
||
|
||
## Examples
|
||
|
||
Hover over the links below to see tooltips:
|
||
|
||
<div class="bd-example tooltip-demo">
|
||
<p class="muted">Tight pants next level keffiyeh <a href="#" data-toggle="tooltip" title="Default tooltip">you probably</a> haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel <a href="#" data-toggle="tooltip" title="Another tooltip">have a</a> terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan <a href="#" data-toggle="tooltip" title="Another one here too">whatever keytar</a>, scenester farm-to-table banksy Austin <a href="#" data-toggle="tooltip" title="The last tip!">twitter handle</a> freegan cred raw denim single-origin coffee viral.
|
||
</p>
|
||
</div>
|
||
|
||
### Static demo
|
||
|
||
Four options are available: top, right, bottom, and left aligned.
|
||
|
||
<div class="bd-example bd-example-tooltip-static">
|
||
<div class="tooltip bs-tooltip-top bs-tooltip-top-docs" role="tooltip">
|
||
<div class="arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the top
|
||
</div>
|
||
</div>
|
||
<div class="tooltip bs-tooltip-right bs-tooltip-right-docs" role="tooltip">
|
||
<div class="arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the right
|
||
</div>
|
||
</div>
|
||
<div class="tooltip bs-tooltip-bottom bs-tooltip-bottom-docs" role="tooltip">
|
||
<div class="arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the bottom
|
||
</div>
|
||
</div>
|
||
<div class="tooltip bs-tooltip-left bs-tooltip-left-docs" role="tooltip">
|
||
<div class="arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Tooltip on the left
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
### Interactive demo
|
||
|
||
Hover over the buttons below to see their tooltips.
|
||
|
||
<div class="bd-example tooltip-demo">
|
||
<div class="bd-example-tooltips">
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">Tooltip with HTML</button>
|
||
</div>
|
||
</div>
|
||
|
||
{% highlight html %}
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
|
||
Tooltip on top
|
||
</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">
|
||
Tooltip on right
|
||
</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">
|
||
Tooltip on bottom
|
||
</button>
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
|
||
Tooltip on left
|
||
</button>
|
||
{% endhighlight %}
|
||
|
||
And with custom HTML added:
|
||
|
||
{% highlight html %}
|
||
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
|
||
Tooltip with HTML
|
||
</button>
|
||
{% endhighlight %}
|
||
|
||
## Usage
|
||
|
||
The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.
|
||
|
||
Trigger the tooltip via JavaScript:
|
||
|
||
{% highlight js %}
|
||
$('#example').tooltip(options)
|
||
{% endhighlight %}
|
||
|
||
### Markup
|
||
|
||
The required markup for a tooltip is only a `data` attribute and `title` on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to `top` by the plugin).
|
||
|
||
{% callout warning %}
|
||
##### Making tooltips work for keyboard and assistive technology users
|
||
|
||
You should only add tooltips 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. In addition, most assistive technologies currently do not announce the tooltip in this situation.
|
||
{% endcallout %}
|
||
|
||
{% highlight html %}
|
||
<!-- HTML to write -->
|
||
<a href="#" data-toggle="tooltip" title="Some tooltip text!">Hover over me</a>
|
||
|
||
<!-- Generated markup by the plugin -->
|
||
<div class="tooltip bs-tooltip-top" role="tooltip">
|
||
<div class="arrow"></div>
|
||
<div class="tooltip-inner">
|
||
Some tooltip text!
|
||
</div>
|
||
</div>
|
||
{% endhighlight %}
|
||
|
||
### Options
|
||
|
||
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-animation=""`.
|
||
|
||
<table class="table table-bordered table-striped table-responsive">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 100px;">Name</th>
|
||
<th style="width: 100px;">Type</th>
|
||
<th style="width: 50px;">Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>animation</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Apply a CSS fade transition to the tooltip</td>
|
||
</tr>
|
||
<tr>
|
||
<td>container</td>
|
||
<td>string | element | false</td>
|
||
<td>false</td>
|
||
<td>
|
||
<p>Appends the tooltip to a specific element. Example: <code>container: 'body'</code>. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>delay</td>
|
||
<td>number | object</td>
|
||
<td>0</td>
|
||
<td>
|
||
<p>Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
|
||
<p>If a number is supplied, delay is applied to both hide/show</p>
|
||
<p>Object structure is: <code>delay: { "show": 500, "hide": 100 }</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>html</td>
|
||
<td>boolean</td>
|
||
<td>false</td>
|
||
<td>
|
||
<p>Allow HTML in the tooltip.</p>
|
||
<p>If true, HTML tags in the tooltip's <code>title</code> will be rendered in the tooltip. If false, jQuery's <code>text</code> method will be used to insert content into the DOM.</p>
|
||
<p>Use text if you're worried about XSS attacks.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>placement</td>
|
||
<td>string | function</td>
|
||
<td>'top'</td>
|
||
<td>
|
||
<p>How to position the tooltip - auto | top | bottom | left | right.<br>When <code>auto</code> is specified, it will dynamically reorient the tooltip.</p>
|
||
<p>When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The <code>this</code> context is set to the tooltip instance.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>selector</td>
|
||
<td>string | false</td>
|
||
<td>false</td>
|
||
<td>If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See <a href="https://github.com/twbs/bootstrap/issues/4215">this</a> and <a href="https://jsbin.com/zopod/1/edit">an informative example</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>template</td>
|
||
<td>string</td>
|
||
<td><code>'<div class="tooltip" role="tooltip"><div class="arrow"></div><div class="tooltip-inner"></div></div>'</code></td>
|
||
<td>
|
||
<p>Base HTML to use when creating the tooltip.</p>
|
||
<p>The tooltip's <code>title</code> will be injected into the <code>.tooltip-inner</code>.</p>
|
||
<p><code>.arrow</code> will become the tooltip's arrow.</p>
|
||
<p>The outermost wrapper element should have the <code>.tooltip</code> class.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>title</td>
|
||
<td>string | element | function</td>
|
||
<td>''</td>
|
||
<td>
|
||
<p>Default title value if <code>title</code> attribute isn't present.</p>
|
||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the tooltip is attached to.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>trigger</td>
|
||
<td>string</td>
|
||
<td>'hover focus'</td>
|
||
<td>How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>offset</td>
|
||
<td>number | string</td>
|
||
<td>0</td>
|
||
<td>Offset of the tooltip relative to its target. For more information refer to Popper.js's <a href="https://popper.js.org/popper-documentation.html#modifiers..offset.offset">offset docs</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>fallbackPlacement</td>
|
||
<td>string | array</td>
|
||
<td>'flip'</td>
|
||
<td>Allow to specify which position Popper will use on fallback. For more information refer to
|
||
Popper.js's <a href="https://popper.js.org/popper-documentation.html#modifiers..flip.behavior">behavior docs</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td>boundary</td>
|
||
<td>string | element</td>
|
||
<td>'scrollParent'</td>
|
||
<td>Overflow constraint boundary of the tooltip. Accepts the values of <code>'viewport'</code>, <code>'window'</code>, <code>'scrollParent'</code>, or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's <a href="https://popper.js.org/popper-documentation.html#modifiers..preventOverflow.boundariesElement">preventOverflow docs</a>.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
{% callout info %}
|
||
#### Data attributes for individual tooltips
|
||
|
||
Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.
|
||
{% endcallout %}
|
||
|
||
### Methods
|
||
|
||
{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
|
||
{{ callout-include | markdownify }}
|
||
|
||
#### `$().tooltip(options)`
|
||
|
||
Attaches a tooltip handler to an element collection.
|
||
|
||
#### `.tooltip('show')`
|
||
|
||
Reveals an element's tooltip. **Returns to the caller before the tooltip has actually been shown** (i.e. before the `shown.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed.
|
||
|
||
{% highlight js %}$('#element').tooltip('show'){% endhighlight %}
|
||
|
||
#### `.tooltip('hide')`
|
||
|
||
Hides an element's tooltip. **Returns to the caller before the tooltip has actually been hidden** (i.e. before the `hidden.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip.
|
||
|
||
{% highlight js %}$('#element').tooltip('hide'){% endhighlight %}
|
||
|
||
#### `.tooltip('toggle')`
|
||
|
||
Toggles an element's tooltip. **Returns to the caller before the tooltip has actually been shown or hidden** (i.e. before the `shown.bs.tooltip` or `hidden.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip.
|
||
|
||
{% highlight js %}$('#element').tooltip('toggle'){% endhighlight %}
|
||
|
||
#### `.tooltip('dispose')`
|
||
|
||
Hides and destroys an element's tooltip. Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements.
|
||
|
||
{% highlight js %}$('#element').tooltip('dispose'){% endhighlight %}
|
||
|
||
#### `.tooltip('enable')`
|
||
|
||
Gives an element's tooltip the ability to be shown. **Tooltips are enabled by default.**
|
||
|
||
{% highlight js %}$('#element').tooltip('enable'){% endhighlight %}
|
||
|
||
#### `.tooltip('disable')`
|
||
|
||
Removes the ability for an element's tooltip to be shown. The tooltip will only be able to be shown if it is re-enabled.
|
||
|
||
{% highlight js %}$('#element').tooltip('disable'){% endhighlight %}
|
||
|
||
#### `.tooltip('toggleEnabled')`
|
||
|
||
Toggles the ability for an element's tooltip to be shown or hidden.
|
||
|
||
{% highlight js %}$('#element').tooltip('toggleEnabled'){% endhighlight %}
|
||
|
||
#### `.tooltip('update')`
|
||
|
||
Updates the position of an element's tooltip.
|
||
|
||
{% highlight js %}$('#element').tooltip('update'){% endhighlight %}
|
||
|
||
### Events
|
||
|
||
<table class="table table-bordered table-striped table-responsive">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>show.bs.tooltip</td>
|
||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shown.bs.tooltip</td>
|
||
<td>This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hide.bs.tooltip</td>
|
||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>hidden.bs.tooltip</td>
|
||
<td>This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).</td>
|
||
</tr>
|
||
<tr>
|
||
<td>inserted.bs.tooltip</td>
|
||
<td>This event is fired after the <code>show.bs.tooltip</code> event when the tooltip template has been added to the DOM.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
{% highlight js %}
|
||
$('#myTooltip').on('hidden.bs.tooltip', function () {
|
||
// do something…
|
||
})
|
||
{% endhighlight %}
|