The javascript tooltip plugin without any dependencies
Isotip is a small (3kb minified and gzipped) and minimal node module to be included in your browserify (or similar) package for use in the browser. Its only dependencies are ES5 and a browser.
It provides a minimal API to configure markup, location, offset, delays, and more. See the API below for more details.
npm install isotip
bower install isotip
Isotip is meant to be IE8+ compatible (with an ES5 shim). If you find otherwise, please open a new issue.
<!doctype html>
<html lang="en">
<head></head>
<body>
<!-- click-based tooltips -->
<div class="tooltip-click" data-tooltip-content="Click-based tooltip"></div>
<!-- hover-based tooltips -->
<div class="tooltip-hover" data-tooltip-content="Hover-based tooltip"></div>
<!-- focus-based tooltips -->
<div class="tooltip-focus" data-tooltip-content="Focus-based tooltip"></div>
<!-- bundle that requires isotip, or the standalone version -->
<script src="/js/bundle.js"></script>
<script src="/js/isotip/dist/isotip.js"></script>
</body>
</html>
Isotip (purposefully) has a simple api. It provides a simple helper function to automatically bind certain events and open tooltips when they fire.
Configuring a specific tooltip is done via data attributes on an element.
This sets the main body content of the tooltip into a <p> tag by default with a class of tooltip-content. Content is interpreted as plain text by default. To insert html, set the data-tooltip-html attribute to true.
This sets the title of the tooltip into a <p> tag by default with a class of tooltip-title.
Setting this to true will force Isotip to try and interpret the content as HTML. If it fails, it will interpret the content as plain text.
This sets the position of the tooltip. Options are top, right, bottom, and left. By default, top is used for all tooltips.
This sets the element that the tooltip will be prepended to. By default, this is the <body> element.
Alternatively, programattic creation and destruction of tooltips is available.
This sets the element that will have a scroll event bound to it. If your tooltip is inside a scrolling element (overflow:scroll), you need to add this!.
The init method provides automatic event binding for tooltips. It sets up delegated event listeners for .tooltip-click, .tooltip-hover, and .tooltip-focus for click, mouseover, and focus events respectively. You can pass in an optional config object to overwrite any of the default options.
var options = {
html: false, // set to true to always interpret content as HTML
placement: 'top', // default placement of tooltips
container: 'body', // default containing element for the tooltip
scrollContainer: '.scroll-container', // default container for scroll watching
template: '<div class="tooltip" data-tooltip-target="tooltip"></div>', // default template for the tooltip shell
removalDelay: 200, // default number of ms before the tooltip is removed
tooltipOffset: 10, // default number of px the tooltip is offset from the trigger element
windowPadding: { // window bounds for tooltip repositioning
top: 10,
right: 10,
bottom: 10,
left: 10
}
};
isotip.init( config );The open method will create the tooltip, insert it into the DOM, and position it in relation to it's trigger. The trigger can be an element or a CSS selector. The object to be passed in will serve as a replacement for the data attributes on the trigger.
var config = {
html: false, // set to true to interpret content as HTML
placement: 'top', // where to place the tooltip in relation to the trigger
content: 'Tooltip content', // the content to go into the tooltip,
title: 'Tooltip title' // the text to go in the title, if any
};
isotip.open( '.tooltip', config );The close method will remove a tooltip from the DOM. The tooltip to remove should be passed in and can be an element or a CSS selector.
isotip.close( '.tooltip' );The positionTooltip method will re-evaluate the position of a tooltip in relation to it's trigger element. Only the tooltip and trigger need to be passed in, and placement will default to what's been configured by init(). Tooltip and trigger can be either an element or a CSS selector.
isotip.positionTooltip( '.tooltip', '.tooltip-click', 'left' );- 1.2.2 - Fixes an edge case when trying to close a tooltip and it didn't exist
- 1.2.0 - Adds a scrollContainer option for tooltips inside scolling elements
- 1.1.2 - Reduces the default tooltip removal delay to 200ms
- 1.1.1 - Fixes a typo in package.json
- 1.1.0 - Fixed a bug where tooltips on far left or right were not positioned correctly. Top positioning has also been improved.
- 1.0.0 - Fixed many browser bugs and tested in many browsers
- 0.4.0 - Added API documentation and finished the basic demo page. More examples will be added to the demo page later
- 0.3.0 - Added a basic demo page. It still needs desktop styles. Also added a couple extra classes on the tooltip for CSS purposes.
- 0.2.0 - IE8 compatability. Added better event handling so that IE8 doesn't throw errors.
- 0.1.0 - Initial version. This doesn't include browser testing or a standalone version