Tooltips

Examples

Tight pants next level keffiyeh you probably 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 have 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 whatever keytar, scenester farm-to-table banksy Austin twitter handle freegan cred raw denim single-origin coffee viral.

Four directions

<button type="button" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
<button type="button" data-toggle="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</button>
<button type="button" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</button>
<button type="button" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>

Contextual alternatives

Like other components, easily make a tooltip more meaningful to a particular context by adding any of the contextual state classes.

<button type="button" class="primary" data-toggle="tooltip" data-contextual="primary" title="Tooltip with primary">Tooltip with primary</button>
<button type="button" class="success" data-toggle="tooltip" data-contextual="success" title="Tooltip with success">Tooltip with success</button>
<button type="button" class="info" data-toggle="tooltip" data-contextual="info" title="Tooltip with info">Tooltip with info</button>
<button type="button" class="warning" data-toggle="tooltip" data-contextual="warning" title="Tooltip with warning">Tooltip with warning</button>
<button type="button" class="danger" data-toggle="tooltip" data-contextual="danger"  title="Tooltip with danger">Tooltip with danger</button>

Usage

The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.

Trigger the tooltip via JavaScript:

$('#example').tooltip(options)

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".

Name Type Default Description
animation boolean true Apply a CSS fade transition to the tooltip
container string | false false

Appends the tooltip to a specific element. Example: container: 'body'. 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.

delay number | object 0

Delay showing and hiding the tooltip (ms) - does not 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 }

html boolean false Insert HTML into the tooltip. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placement string | function 'top' How to position the tooltip - top | bottom | left | right | auto.
When "auto" is specified, it will dynamically reorient the tooltip. For example, if placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.
contextual string '' Like other components, easily make a tooltip more meaningful to a particular context by adding any of the contextual state classes.
Options: primary | success | info | warning | danger
selector string false 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 tooltips added.
template string '<div class="tooltip" role="tooltip"><div class="arrow"></div><div class="inner"></div></div>'

Base HTML to use when creating the tooltip.

The tooltip's title will be injected into the .inner.

.arrow will become the tooltip's arrow.

The outermost wrapper element should have the .tooltip class.

title string | function '' Default title value if title attribute isn't present
trigger string 'hover focus' How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
viewport string | object { selector: 'body', padding: 0 }

Keeps the tooltip within the bounds of this element. Example: viewport: '#viewport' or { selector: '#viewport', padding: 0 }

Events

Event Type Description
show.mice.tooltip This event fires immediately when the show instance method is called.
shown.mice.tooltip This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.mice.tooltip This event is fired immediately when the hide instance method has been called.
hidden.mice.tooltip This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
$('#myTooltip').on('hidden.mice.tooltip', function () {
  // do something…
})