How to add tooltip in Magento 2

How to add tooltip in Magento 2

July 14, 2026 · Illustrated author avatarBy Stefan Bogdanescu
How to add tooltip in Magento 2

Adding Tooltips in Magento 2: A Comprehensive Guide

As a developer working on custom themes for Magento 2, you might find yourself needing to add tooltips to enhance the user experience. In this post, we’ll walk through the process of adding custom tooltips step by step.

Firstly, let’s address the issue raised by the user who attempted to add a tooltip using a custom template and CSS styles. The provided code demonstrates an understanding of the basic structure required for a tooltip:

<span class="custom-tooltip">
    <a href="#" class="tooltip-toggle">Test ?</a>
    <span class="tooltip-content">Tolltip description come here</span>
</span>

And the associated CSS styles in styles-l.css:

.custom-tooltip {
    .lib-tooltip(right);
}

While this approach is partly correct, it misses some crucial steps that are necessary for Magento 2’s tooltip functionality to work properly.

Understanding Magento 2 Tooltips

Magento 2 uses the lib/tooltip.js library to handle tooltips. This library requires specific markup and JavaScript integration to function correctly within a Magento theme.

To begin adding tooltips, you’ll need to include the necessary JavaScript file in your custom template:

<script src="{{ view_file('lib_tooltip.js') }}"></script>

Ensure that this script is included after the main Magento JavaScript files (Magento_Customer/js/customer-data.js and Magento_Theme/js/mage/requirejs-config.js) to avoid conflicts.

The Correct Tooltip Structure

The tooltip structure in your template should look like this:

<div class="lib-tooltip" data-trigger="right">
    <a href="#" class="tooltip-toggle">Test ?</a>
    <span class="tooltip-content">Tolltip description come here</span>
</div>

Notice the changes made:

  • The parent container for the tooltip is now a div element with the lib-tooltip class.
  • The data-trigger attribute specifies the position of the tooltip (“right” in this case).

Styling the Tooltip

To style your tooltip, you can use CSS as shown in the user’s example:

.custom-tooltip {
    .lib-tooltip(right);
}

However, Magento 2 requires a more specific selector to target the tooltips. Update your styles to use the following rule:

.lib-tooltip {
    position: relative;
}

.lib-tooltip[data-trigger="right"] .tooltip-content {
    width: auto;
    left: 100%;
    top: -5px;
}

This CSS ensures that the tooltip is positioned correctly and appears on the right side of its trigger element.

Conclusion

Adding tooltips in Magento 2 requires a combination of proper markup, JavaScript inclusion, and specific styling. By following the steps outlined above, you should now be able to create functional and well-styled tooltips within your custom themes.

Remember that when working with custom themes, it’s essential to keep your code organized and follow best practices for maintainability and performance.

For more in-depth guides on Magento 2 development and customization, be sure to check out the comprehensive resources available at Laravel Company.

Happy coding!

Magento 2 Themes Configuration Customers

Our network