Tailwind CSS Tooltip & Popover Plugin API

Installation

To get started, install the Tooltip & Popover plugin via npm, else you can skip this step if you are already using Preline UI as a package.

1. Install the plugin

   Install @preline/tooltip via npm

   Terminal

                             
                               npm i @preline/tooltip
                             
                           

2. Add the plugin CSS

   Use @source to register the plugin's JavaScript path for Tailwind CSS scanning, then @import the plugin's CSS files into your Tailwind CSS file.

   main.css

                             
                               @import "tailwindcss";
                               
                               /* @preline/tooltip */
                               /* [!code highlight:3] */
                               @source "../node_modules/@preline/tooltip/*.js";
                               @import "./node_modules/@preline/tooltip/variants.css";
                               @import "./node_modules/@preline/tooltip/theme.css";
                             
                           

3. Add the plugin JavaScript

   Include the JavaScript <script> that powers the interactive elements near the end of your </body> tag:

   HTML

   <script src="./node_modules/@preline/tooltip/index.js"></script>

   ---

   Additional Initialization Options

   Use the non-auto entry if you need manual initialization. In this mode, automatic initialization on page load is not included, so the component should be initialized explicitly.

   HTML (non-auto)

   <script type="module"> // [!code highlight:3] import HSTooltip from "@preline/tooltip/non-auto.mjs"; new HSTooltip(document.querySelector("#tooltip")); </script>

   ---

   Via bundler

   When using a bundler (Vite, webpack, etc.), import the plugin directly as an ES module.

   JavaScript (auto)

                             
                               import "@preline/tooltip";
                             
                           

   JavaScript (non-auto)

                             
                               import HSTooltip from "@preline/tooltip/non-auto";
                               
                               HSTooltip.autoInit();
                               
                               // Or initialize a specific element manually
                               const el = document.querySelector("#tooltip");
                               if (el) new HSTooltip(el);
                             
                           

Example

Hover over the buttons below to see the four tooltip directions: top, right, bottom, and left. Remove the [--placement:*] option to enable automatic positioning.

Basic usage

Prefer to create your own style? Here is a completely unstylized example.

                      
                        <div class="hs-tooltip inline-block">
                          <button type="button" class="hs-tooltip-toggle">
                            Hover me
                            <span class="hs-tooltip-content hs-tooltip-shown:opacity-100 hs-tooltip-shown:visible opacity-0 transition-opacity inline-block absolute invisible z-10 py-1 px-2 bg-stone-900 text-white" role="tooltip">
                              Tooltip on top
                            </span>
                          </button>
                        </div>
                      
                    

Selectors

Methods

The HSTooltip object is contained within the global window object

                      
                        const tooltip = new HSTooltip(document.querySelector('#tooltip'));
                        const showBtn = document.querySelector('#show-btn');

                        showBtn.addEventListener('click', () => {
                          tooltip.show();
                        });
                      
                    

                      
                        const showBtn = document.querySelector('#show-btn');

                        showBtn.addEventListener('click', () => {
                          HSTooltip.show(document.querySelector('#tooltip'));
                        });
                      
                    

                      
                        const { element } = HSTooltip.getInstance('#tooltip', true);
                        const showBtn = document.querySelector('#show-btn');

                        showBtn.addEventListener('click', () => {
                          element.show();
                        });
                      
                    

Events

                      
                        const el = HSTooltip.getInstance('#tooltip');

                        el.on('show', (instance) => {...});
                      
                    

Ready to use Components

Tooltip & Popover

Explore ready-to-use Tailwind CSS examples built with Preline UI.

View Tooltip & Popover examples