<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <title> Tooltips · Bootstrap </title> <!-- Twitter --> <meta name="twitter:site" content="@getbootstrap"> <meta name="twitter:creator" content="@getbootstrap"> <meta name="twitter:card" content="summary"> <meta name="twitter:title" content="Tooltips"> <meta name="twitter:description" content="Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage."> <meta name="twitter:image" content="https://getbootstrap.com/assets/brand/bootstrap-social-logo.png"> <!-- Facebook --> <meta property="og:url" content="https://getbootstrap.com/docs/4.0/components/tooltips/"> <meta property="og:title" content="Tooltips"> <meta property="og:description" content="Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage."> <meta property="og:type" content="website"> <meta property="og:image" content="http://getbootstrap.com/assets/brand/bootstrap-social.png"> <meta property="og:image:secure_url" content="https://getbootstrap.com/assets/brand/bootstrap-social.png"> <meta property="og:image:type" content="image/png"> <meta property="og:image:width" content="1200"> <meta property="og:image:height" content="630"> <!-- Meta --> <meta name="description" content="The most popular HTML, CSS, and JS library in the world."> <meta name="author" content="Mark Otto, Jacob Thornton, and Bootstrap contributors"> <!-- Bootstrap core CSS --> <link href="/dist/css/bootstrap.min.css" rel="stylesheet"> <!-- Documentation extras --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" /> <link href="/assets/css/docs.min.css" rel="stylesheet"> <!-- Favicons --> <link rel="apple-touch-icon" href="/apple-touch-icon.png"> <link rel="icon" href="/favicon.ico"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-146052-10', 'getbootstrap.com'); ga('send', 'pageview'); </script> </head> <body class="bd-docs" data-spy="scroll" data-target=".bd-sidenav-active"> <a id="skippy" class="sr-only sr-only-focusable" href="#content"> <div class="container"> <span class="skiplink-text">Skip to main content</span> </div> </a> <header class="navbar navbar-expand navbar-dark flex-column flex-md-row bd-navbar"> <a class="navbar-brand mr-0 mr-md-2" href="/" aria-label="Bootstrap"> <svg class="d-block" width="36" height="36" viewbox="0 0 612 612" xmlns="http://www.w3.org/2000/svg" focusable="false"><title>Bootstrap</title><path fill="currentColor" d="M510 8a94.3 94.3 0 0 1 94 94v408a94.3 94.3 0 0 1-94 94H102a94.3 94.3 0 0 1-94-94V102a94.3 94.3 0 0 1 94-94h408m0-8H102C45.9 0 0 45.9 0 102v408c0 56.1 45.9 102 102 102h408c56.1 0 102-45.9 102-102V102C612 45.9 566.1 0 510 0z"/><path fill="currentColor" d="M196.77 471.5V154.43h124.15c54.27 0 91 31.64 91 79.1 0 33-24.17 63.72-54.71 69.21v1.76c43.07 5.49 70.75 35.82 70.75 78 0 55.81-40 89-107.45 89zm39.55-180.4h63.28c46.8 0 72.29-18.68 72.29-53 0-31.42-21.53-48.78-60-48.78h-75.57zm78.22 145.46c47.68 0 72.73-19.34 72.73-56s-25.93-55.37-76.46-55.37h-74.49v111.4z"/></svg> </a> <div class="navbar-nav-scroll"> <ul class="navbar-nav bd-navbar-nav flex-row"> <li class="nav-item"> <a class="nav-link " href="/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Bootstrap');">Home</a> </li> <li class="nav-item"> <a class="nav-link active" href="/docs/4.0/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Docs');">Documentation</a> </li> <li class="nav-item"> <a class="nav-link " href="/docs/4.0/examples/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Examples');">Examples</a> </li> <li class="nav-item"> <a class="nav-link" href="https://themes.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Themes');" target="_blank" rel="noopener">Themes</a> </li> <li class="nav-item"> <a class="nav-link" href="https://jobs.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Jobs');" target="_blank" rel="noopener">Jobs</a> </li> <li class="nav-item"> <a class="nav-link" href="https://expo.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Expo');" target="_blank" rel="noopener">Expo</a> </li> <li class="nav-item"> <a class="nav-link" href="https://blog.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Blog');" target="_blank" rel="noopener">Blog</a> </li> </ul> </div> <ul class="navbar-nav flex-row ml-md-auto d-none d-md-flex"> <li class="nav-item dropdown"> <a class="nav-item nav-link dropdown-toggle mr-md-2" href="#" id="bd-versions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> v4.0 </a> <div class="dropdown-menu dropdown-menu-right" aria-labelledby="bd-versions"> <a class="dropdown-item active" href="/docs/4.0/">Latest (4.x)</a> <a class="dropdown-item" href="https://v4-alpha.getbootstrap.com">v4 Alpha 6</a> <a class="dropdown-item" href="https://getbootstrap.com/docs/3.3/">v3.3.7</a> <a class="dropdown-item" href="https://getbootstrap.com/2.3.2/">v2.3.2</a> </div> </li> <li class="nav-item"> <a class="nav-link p-2" href="https://github.com/twbs/bootstrap" target="_blank" rel="noopener" aria-label="GitHub"> <svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 499.36" focusable="false"><title>GitHub</title><path d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z" fill="currentColor" fill-rule="evenodd"/></svg> </a> </li> <li class="nav-item"> <a class="nav-link p-2" href="https://twitter.com/getbootstrap" target="_blank" rel="noopener" aria-label="Twitter"> <svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 416.32" focusable="false"><title>Twitter</title><path d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92" fill="currentColor"/></svg> </a> </li> <li class="nav-item"> <a class="nav-link p-2" href="https://bootstrap-slack.herokuapp.com" target="_blank" rel="noopener" aria-label="Slack"> <svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" focusable="false"><title>Slack</title><path fill="currentColor" d="M210.787 234.832l68.31-22.883 22.1 65.977-68.309 22.882z"/><path d="M490.54 185.6C437.7 9.59 361.6-31.34 185.6 21.46S-31.3 150.4 21.46 326.4 150.4 543.3 326.4 490.54 543.34 361.6 490.54 185.6zM401.7 299.8l-33.15 11.05 11.46 34.38c4.5 13.92-2.87 29.06-16.78 33.56-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18l-11.46-34.38-68.36 22.92 11.46 34.38c4.5 13.92-2.87 29.06-16.78 33.56-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18l-11.46-34.43-33.15 11.05c-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18c-4.5-13.92 2.87-29.06 16.78-33.56l33.12-11.03-22.1-65.9-33.15 11.05c-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18c-4.48-13.93 2.89-29.07 16.81-33.58l33.15-11.05-11.46-34.38c-4.5-13.92 2.87-29.06 16.78-33.56s29.06 2.87 33.56 16.78l11.46 34.38 68.36-22.92-11.46-34.38c-4.5-13.92 2.87-29.06 16.78-33.56s29.06 2.87 33.56 16.78l11.47 34.42 33.15-11.05c13.92-4.5 29.06 2.87 33.56 16.78s-2.87 29.06-16.78 33.56L329.7 194.6l22.1 65.9 33.15-11.05c13.92-4.5 29.06 2.87 33.56 16.78s-2.88 29.07-16.81 33.57z" fill="currentColor"/></svg> </a> </li> </ul> <a class="btn btn-bd-yellow d-none d-lg-inline-block mb-3 mb-md-0 ml-md-3" href="https://github.com/twbs/bootstrap/archive/v4.0.0-beta.zip">Download</a> </header> <div class="container-fluid"> <div class="row flex-xl-nowrap"> <div class="col-12 col-md-3 col-xl-2 bd-sidebar"> <form class="bd-search d-flex align-items-center"> <input type="search" class="form-control" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off"> <button class="btn-link bd-search-docs-toggle d-md-none p-0 ml-3" type="button" data-toggle="collapse" data-target="#bd-docs-nav" aria-controls="bd-docs-nav" aria-expanded="false" aria-label="Toggle docs avigation"> <svg class="" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 30 30" width="30" height="30" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-miterlimit="10" d="M4 7h22M4 15h22M4 23h22"/></svg> </button> </form> <nav class="collapse bd-links" id="bd-docs-nav"> <div class="bd-toc-item "> <a class="bd-toc-link" href="/docs/4.0/getting-started/introduction/"> Getting started </a> <ul class="nav bd-sidenav"> <li class=""> <a href="/docs/4.0/getting-started/introduction/"> Introduction </a> </li> <li class=""> <a href="/docs/4.0/getting-started/download/"> Download </a> </li> <li class=""> <a href="/docs/4.0/getting-started/contents/"> Contents </a> </li> <li class=""> <a href="/docs/4.0/getting-started/browsers-devices/"> Browsers & devices </a> </li> <li class=""> <a href="/docs/4.0/getting-started/javascript/"> JavaScript </a> </li> <li class=""> <a href="/docs/4.0/getting-started/options/"> Options </a> </li> <li class=""> <a href="/docs/4.0/getting-started/build-tools/"> Build tools </a> </li> <li class=""> <a href="/docs/4.0/getting-started/webpack/"> Webpack </a> </li> <li class=""> <a href="/docs/4.0/getting-started/accessibility/"> Accessibility </a> </li> </ul> </div> <div class="bd-toc-item "> <a class="bd-toc-link" href="/docs/4.0/layout/overview/"> Layout </a> <ul class="nav bd-sidenav"> <li class=""> <a href="/docs/4.0/layout/overview/"> Overview </a> </li> <li class=""> <a href="/docs/4.0/layout/grid/"> Grid </a> </li> <li class=""> <a href="/docs/4.0/layout/media-object/"> Media object </a> </li> <li class=""> <a href="/docs/4.0/layout/utilities-for-layout/"> Utilities for layout </a> </li> </ul> </div> <div class="bd-toc-item "> <a class="bd-toc-link" href="/docs/4.0/content/reboot/"> Content </a> <ul class="nav bd-sidenav"> <li class=""> <a href="/docs/4.0/content/reboot/"> Reboot </a> </li> <li class=""> <a href="/docs/4.0/content/typography/"> Typography </a> </li> <li class=""> <a href="/docs/4.0/content/code/"> Code </a> </li> <li class=""> <a href="/docs/4.0/content/images/"> Images </a> </li> <li class=""> <a href="/docs/4.0/content/tables/"> Tables </a> </li> <li class=""> <a href="/docs/4.0/content/figures/"> Figures </a> </li> </ul> </div> <div class="bd-toc-item active"> <a class="bd-toc-link" href="/docs/4.0/components/alerts/"> Components </a> <ul class="nav bd-sidenav"> <li class=""> <a href="/docs/4.0/components/alerts/"> Alerts </a> </li> <li class=""> <a href="/docs/4.0/components/badge/"> Badge </a> </li> <li class=""> <a href="/docs/4.0/components/breadcrumb/"> Breadcrumb </a> </li> <li class=""> <a href="/docs/4.0/components/buttons/"> Buttons </a> </li> <li class=""> <a href="/docs/4.0/components/button-group/"> Button group </a> </li> <li class=""> <a href="/docs/4.0/components/card/"> Card </a> </li> <li class=""> <a href="/docs/4.0/components/carousel/"> Carousel </a> </li> <li class=""> <a href="/docs/4.0/components/collapse/"> Collapse </a> </li> <li class=""> <a href="/docs/4.0/components/dropdowns/"> Dropdowns </a> </li> <li class=""> <a href="/docs/4.0/components/forms/"> Forms </a> </li> <li class=""> <a href="/docs/4.0/components/input-group/"> Input group </a> </li> <li class=""> <a href="/docs/4.0/components/jumbotron/"> Jumbotron </a> </li> <li class=""> <a href="/docs/4.0/components/list-group/"> List group </a> </li> <li class=""> <a href="/docs/4.0/components/modal/"> Modal </a> </li> <li class=""> <a href="/docs/4.0/components/navs/"> Navs </a> </li> <li class=""> <a href="/docs/4.0/components/navbar/"> Navbar </a> </li> <li class=""> <a href="/docs/4.0/components/pagination/"> Pagination </a> </li> <li class=""> <a href="/docs/4.0/components/popovers/"> Popovers </a> </li> <li class=""> <a href="/docs/4.0/components/progress/"> Progress </a> </li> <li class=""> <a href="/docs/4.0/components/scrollspy/"> Scrollspy </a> </li> <li class="active bd-sidenav-active"> <a href="/docs/4.0/components/tooltips/"> Tooltips </a> </li> </ul> </div> <div class="bd-toc-item "> <a class="bd-toc-link" href="/docs/4.0/utilities/borders/"> Utilities </a> <ul class="nav bd-sidenav"> <li class=""> <a href="/docs/4.0/utilities/borders/"> Borders </a> </li> <li class=""> <a href="/docs/4.0/utilities/clearfix/"> Clearfix </a> </li> <li class=""> <a href="/docs/4.0/utilities/close-icon/"> Close icon </a> </li> <li class=""> <a href="/docs/4.0/utilities/colors/"> Colors </a> </li> <li class=""> <a href="/docs/4.0/utilities/display/"> Display </a> </li> <li class=""> <a href="/docs/4.0/utilities/embed/"> Embed </a> </li> <li class=""> <a href="/docs/4.0/utilities/flex/"> Flex </a> </li> <li class=""> <a href="/docs/4.0/utilities/float/"> Float </a> </li> <li class=""> <a href="/docs/4.0/utilities/image-replacement/"> Image replacement </a> </li> <li class=""> <a href="/docs/4.0/utilities/position/"> Position </a> </li> <li class=""> <a href="/docs/4.0/utilities/screenreaders/"> Screenreaders </a> </li> <li class=""> <a href="/docs/4.0/utilities/sizing/"> Sizing </a> </li> <li class=""> <a href="/docs/4.0/utilities/spacing/"> Spacing </a> </li> <li class=""> <a href="/docs/4.0/utilities/text/"> Text </a> </li> <li class=""> <a href="/docs/4.0/utilities/vertical-align/"> Vertical align </a> </li> <li class=""> <a href="/docs/4.0/utilities/visibility/"> Visibility </a> </li> </ul> </div> <div class="bd-toc-item "> <a class="bd-toc-link" href="/docs/4.0/extend/icons/"> Extend </a> <ul class="nav bd-sidenav"> <li class=""> <a href="/docs/4.0/extend/icons/"> Icons </a> </li> </ul> </div> <div class="bd-toc-item "> <a class="bd-toc-link" href="/docs/4.0/migration/"> Migration </a> <ul class="nav bd-sidenav"> </ul> </div> </nav> </div> <div class="d-none d-xl-block col-xl-2 bd-toc"> <ul class="section-nav"> <li class="toc-entry toc-h2"><a href="#overview">Overview</a></li> <li class="toc-entry toc-h2"><a href="#example-enable-tooltips-everywhere">Example: Enable tooltips everywhere</a></li> <li class="toc-entry toc-h2"><a href="#examples">Examples</a> <ul> <li class="toc-entry toc-h3"><a href="#static-demo">Static demo</a></li> <li class="toc-entry toc-h3"><a href="#interactive-demo">Interactive demo</a></li> </ul> </li> <li class="toc-entry toc-h2"><a href="#usage">Usage</a> <ul> <li class="toc-entry toc-h3"><a href="#markup">Markup</a> <ul> <li class="toc-entry toc-h4"><a href="#making-tooltips-work-for-keyboard-and-assistive-technology-users">Making tooltips work for keyboard and assistive technology users</a></li> </ul> </li> <li class="toc-entry toc-h3"><a href="#options">Options</a> <ul> <li class="toc-entry toc-h4"><a href="#data-attributes-for-individual-tooltips">Data attributes for individual tooltips</a></li> </ul> </li> <li class="toc-entry toc-h3"><a href="#methods">Methods</a> <ul> <li class="toc-entry toc-h4"><a href="#asynchronous-methods-and-transitions">Asynchronous methods and transitions</a></li> <li class="toc-entry toc-h4"><a href="#tooltipoptions">$().tooltip(options)</a></li> <li class="toc-entry toc-h4"><a href="#tooltipshow">.tooltip('show')</a></li> <li class="toc-entry toc-h4"><a href="#tooltiphide">.tooltip('hide')</a></li> <li class="toc-entry toc-h4"><a href="#tooltiptoggle">.tooltip('toggle')</a></li> <li class="toc-entry toc-h4"><a href="#tooltipdispose">.tooltip('dispose')</a></li> <li class="toc-entry toc-h4"><a href="#tooltipenable">.tooltip('enable')</a></li> <li class="toc-entry toc-h4"><a href="#tooltipdisable">.tooltip('disable')</a></li> <li class="toc-entry toc-h4"><a href="#tooltiptoggleenabled">.tooltip('toggleEnabled')</a></li> <li class="toc-entry toc-h4"><a href="#tooltipupdate">.tooltip('update')</a></li> </ul> </li> <li class="toc-entry toc-h3"><a href="#events">Events</a></li> </ul> </li> </ul> </div> <main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 bd-content" role="main"> <h1 class="bd-title" id="content">Tooltips</h1> <p class="bd-lead">Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage.</p> <script async type="text/javascript" src="https://cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=getbootstrapcom" id="_carbonads_js"></script> <h2 id="overview">Overview</h2> <p>Things to know when using the tooltip plugin:</p> <ul> <li>Tooltips rely on the 3rd party library <a href="https://popper.js.org">Popper.js</a> for positioning. You must include <a href="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js">popper.min.js</a> before bootstrap.js in order for tooltips to work!</li> <li>Tooltips are opt-in for performance reasons, so <strong>you must initialize them yourself</strong>.</li> <li>Tooltips with zero-length titles are never displayed.</li> <li>Specify <code class="highlighter-rouge">container: 'body'</code> to avoid rendering problems in more complex components (like our input groups, button groups, etc).</li> <li>Triggering tooltips on hidden elements will not work.</li> <li>Tooltips for <code class="highlighter-rouge">.disabled</code> or <code class="highlighter-rouge">disabled</code> elements must be triggered on a wrapper element.</li> <li>When triggered from hyperlinks that span multiple lines, tooltips will be centered. Use <code class="highlighter-rouge">white-space: nowrap;</code> on your <code class="highlighter-rouge"><a></code>s to avoid this behavior.</li> <li>Tooltips must be hidden before their corresponding elements have been removed from the DOM.</li> </ul> <p>Got all that? Great, let’s see how they work with some examples.</p> <h2 id="example-enable-tooltips-everywhere">Example: Enable tooltips everywhere</h2> <p>One way to initialize all tooltips on a page would be to select them by their <code class="highlighter-rouge">data-toggle</code> attribute:</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span> <span class="nx">$</span><span class="p">(</span><span class="s1">'[data-toggle="tooltip"]'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">()</span> <span class="p">})</span></code></pre></figure> <h2 id="examples">Examples</h2> <p>Hover over the links below to see tooltips:</p> <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> <h3 id="static-demo">Static demo</h3> <p>Four options are available: top, right, bottom, and left aligned.</p> <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> <h3 id="interactive-demo">Interactive demo</h3> <p>Hover over the buttons below to see their tooltips.</p> <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> <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-secondary"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"top"</span> <span class="na">title=</span><span class="s">"Tooltip on top"</span><span class="nt">></span> Tooltip on top <span class="nt"></button></span> <span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-secondary"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"right"</span> <span class="na">title=</span><span class="s">"Tooltip on right"</span><span class="nt">></span> Tooltip on right <span class="nt"></button></span> <span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-secondary"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"bottom"</span> <span class="na">title=</span><span class="s">"Tooltip on bottom"</span><span class="nt">></span> Tooltip on bottom <span class="nt"></button></span> <span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-secondary"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-placement=</span><span class="s">"left"</span> <span class="na">title=</span><span class="s">"Tooltip on left"</span><span class="nt">></span> Tooltip on left <span class="nt"></button></span></code></pre></figure> <p>And with custom HTML added:</p> <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><button</span> <span class="na">type=</span><span class="s">"button"</span> <span class="na">class=</span><span class="s">"btn btn-secondary"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">data-html=</span><span class="s">"true"</span> <span class="na">title=</span><span class="s">"<em>Tooltip</em> <u>with</u> <b>HTML</b>"</span><span class="nt">></span> Tooltip with HTML <span class="nt"></button></span></code></pre></figure> <h2 id="usage">Usage</h2> <p>The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.</p> <p>Trigger the tooltip via JavaScript:</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#example'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span></code></pre></figure> <h3 id="markup">Markup</h3> <p>The required markup for a tooltip is only a <code class="highlighter-rouge">data</code> attribute and <code class="highlighter-rouge">title</code> 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 <code class="highlighter-rouge">top</code> by the plugin).</p> <div class="bd-callout bd-callout-warning"> <h4 id="making-tooltips-work-for-keyboard-and-assistive-technology-users">Making tooltips work for keyboard and assistive technology users</h4> <p>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 <code class="highlighter-rouge"><span></code>s) can be made focusable by adding the <code class="highlighter-rouge">tabindex="0"</code> 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.</p> </div> <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="c"><!-- HTML to write --></span> <span class="nt"><a</span> <span class="na">href=</span><span class="s">"#"</span> <span class="na">data-toggle=</span><span class="s">"tooltip"</span> <span class="na">title=</span><span class="s">"Some tooltip text!"</span><span class="nt">></span>Hover over me<span class="nt"></a></span> <span class="c"><!-- Generated markup by the plugin --></span> <span class="nt"><div</span> <span class="na">class=</span><span class="s">"tooltip bs-tooltip-top"</span> <span class="na">role=</span><span class="s">"tooltip"</span><span class="nt">></span> <span class="nt"><div</span> <span class="na">class=</span><span class="s">"arrow"</span><span class="nt">></div></span> <span class="nt"><div</span> <span class="na">class=</span><span class="s">"tooltip-inner"</span><span class="nt">></span> Some tooltip text! <span class="nt"></div></span> <span class="nt"></div></span></code></pre></figure> <h3 id="options">Options</h3> <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code class="highlighter-rouge">data-</code>, as in <code class="highlighter-rouge">data-animation=""</code>.</p> <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</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> </tbody> </table> <div class="bd-callout bd-callout-info"> <h4 id="data-attributes-for-individual-tooltips">Data attributes for individual tooltips</h4> <p>Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.</p> </div> <h3 id="methods">Methods</h3> <div class="bd-callout bd-callout-danger"> <h4 id="asynchronous-methods-and-transitions">Asynchronous methods and transitions</h4> <p>All API methods are <strong>asynchronous</strong> and start a <strong>transition</strong>. They returns to the caller as soon as the transition is started but <strong>before it ends</strong>. In addition, a method call on a <strong>transitioning component will be ignored</strong>.</p> <p><a href="/getting-started/javascript/">See our Javascript documentation for more informations.</a></p> </div> <h4 id="tooltipoptions"><code class="highlighter-rouge">$().tooltip(options)</code></h4> <p>Attaches a tooltip handler to an element collection.</p> <h4 id="tooltipshow"><code class="highlighter-rouge">.tooltip('show')</code></h4> <p>Reveals an element’s tooltip. <strong>Returns to the caller before the tooltip has actually been shown</strong> (i.e. before the <code class="highlighter-rouge">shown.bs.tooltip</code> event occurs). This is considered a “manual” triggering of the tooltip. Tooltips with zero-length titles are never displayed.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltiphide"><code class="highlighter-rouge">.tooltip('hide')</code></h4> <p>Hides an element’s tooltip. <strong>Returns to the caller before the tooltip has actually been hidden</strong> (i.e. before the <code class="highlighter-rouge">hidden.bs.tooltip</code> event occurs). This is considered a “manual” triggering of the tooltip.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'hide'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltiptoggle"><code class="highlighter-rouge">.tooltip('toggle')</code></h4> <p>Toggles an element’s tooltip. <strong>Returns to the caller before the tooltip has actually been shown or hidden</strong> (i.e. before the <code class="highlighter-rouge">shown.bs.tooltip</code> or <code class="highlighter-rouge">hidden.bs.tooltip</code> event occurs). This is considered a “manual” triggering of the tooltip.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'toggle'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltipdispose"><code class="highlighter-rouge">.tooltip('dispose')</code></h4> <p>Hides and destroys an element’s tooltip. Tooltips that use delegation (which are created using <a href="#options">the <code class="highlighter-rouge">selector</code> option</a>) cannot be individually destroyed on descendant trigger elements.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'dispose'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltipenable"><code class="highlighter-rouge">.tooltip('enable')</code></h4> <p>Gives an element’s tooltip the ability to be shown. <strong>Tooltips are enabled by default.</strong></p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'enable'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltipdisable"><code class="highlighter-rouge">.tooltip('disable')</code></h4> <p>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.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'disable'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltiptoggleenabled"><code class="highlighter-rouge">.tooltip('toggleEnabled')</code></h4> <p>Toggles the ability for an element’s tooltip to be shown or hidden.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'toggleEnabled'</span><span class="p">)</span></code></pre></figure> <h4 id="tooltipupdate"><code class="highlighter-rouge">.tooltip('update')</code></h4> <p>Updates the position of an element’s tooltip.</p> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">tooltip</span><span class="p">(</span><span class="s1">'update'</span><span class="p">)</span></code></pre></figure> <h3 id="events">Events</h3> <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> <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myTooltip'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'hidden.bs.tooltip'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span> <span class="c1">// do something…</span> <span class="p">})</span></code></pre></figure> </main> </div> </div> <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script> <script>window.jQuery || document.write('<script src="/assets/js/vendor/jquery-slim.min.js"><\/script>')</script> <script src="/assets/js/vendor/popper.min.js"></script> <script src="/dist/js/bootstrap.min.js"></script> <script src="/assets/js/docs.min.js"></script> <!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> <script src="/assets/js/ie10-viewport-bug-workaround.js"></script> <script src="/assets/js/ie-emulation-modes-warning.js"></script> <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script> <script type="text/javascript"> var docsearch = docsearch({ apiKey: '48cb48b22351bc71ea5f12f4d1ede198', indexName: 'bootstrap-v4', inputSelector: '#search-input', handleSelected: function (input, event, suggestion) { var url = suggestion.url; url = suggestion.isLvl1 ? url.split('#')[0]: url; // If it's a title we remove the anchor so it does not jump. window.location.href = url; }, transformData: function (hits) { return hits.map(function (hit) { hit.url = hit.url.replace('https://v4-alpha.getbootstrap.com', '/docs/4.0'); return hit; }); }, debug: false // Set debug to true if you want to inspect the dropdown }); </script> <script> Holder.addTheme('gray', { bg: '#777', fg: 'rgba(255,255,255,.75)', font: 'Helvetica', fontweight: 'normal' }) </script> </body> </html>