boost-js-tooltip
A style-free tooltip plugin for jQuery and Boost JS
A style-free tooltip plugin for jQuery and Boost JS. While other plugins style your tooltip for you, this plugin only handles the functionality, leaving the layout styling up to you.
Install with npm:
npm install boost-js-tooltip
Install in browser:
<script src="https://cdn.rawgit.com/marksmccann/boost-js-tooltip/v0.0.1/dist/tooltip.min.js"></script>
var boost = require('boost-js');
// var boost = $.fn.boost; (browser install)
var tooltip = require('boost-js-tooltip');
// var tooltip = $.fn.boost.tooltip; (browser install)
$.fn.tooltip = boost( tooltip.plugin, tooltip.defaults );
<button id="tooltip" title="Your tooltip message goes here">...</button>
$('#tooltip').tooltip();
Name | Default | Description |
---|---|---|
activeClass | "is-visible" |
the class added to the tip when activated |
tipClass | "tooltip" |
a class added to tip and used to prefix placement class |
placement | "top" |
the position of the tip relative to the source. Options: top, left, right, center. |
margin | 10 |
the number of pixels from the source element |
onShow | null |
a callback function called after the tooltip is made visible |
onHide | null |
a callback function called after the tooltip is hidden |
onInit | null |
a callback function called after the tooltip is initialized |
$('#tooltip').tooltip({
onInit: function() {
console.log( this.id ); // 'tooltip'
}
});
- or -
<button id="tooltip" ... data-placement="bottom">...</button>
Shows the tooltip. fn
: optional callback function called after opening.
instance.show();
Hides the tooltip. fn
: optional callback function called after closing.
instance.hide();
Determines if tooltip is visible or not.
instance.isVisible();
Calculates the sets the top/left position for the tip element.
instance.setPosition();
Stores the original value of the title attribute.
instance.title;
The tooltip element.
instance.tip;
$ npm install && npm test
Copyright © 2016, Mark McCann. Released under the MIT license.