' . __( 'Hover over the icons to see a tooltip preview!', 'wp-wiki-tooltip' ) . '
'; } public function print_tooltip_head_field( $args ) { diff --git a/class.wp-wiki-tooltip-base.php b/class.wp-wiki-tooltip-base.php index fc1b253..7584826 100644 --- a/class.wp-wiki-tooltip-base.php +++ b/class.wp-wiki-tooltip-base.php @@ -4,7 +4,7 @@ */ class WP_Wiki_Tooltip_Base { - protected $version = '1.7.4'; + protected $version = '1.8.0'; protected $options = false; } \ No newline at end of file diff --git a/class.wp-wiki-tooltip-comm.php b/class.wp-wiki-tooltip-comm.php index 6602fe6..52e2b0b 100644 --- a/class.wp-wiki-tooltip-comm.php +++ b/class.wp-wiki-tooltip-comm.php @@ -48,10 +48,18 @@ public function ajax_get_wiki_page() { $wiki_url = $_REQUEST[ 'wurl' ]; $page_url = $_REQUEST[ 'purl' ]; $thumb_enable = $_REQUEST[ 'tenable' ]; - $thumb_width = $_REQUEST[ 'twidth' ]; + $thumb_width = $_REQUEST[ 'twidth' ]; + $error_title = $_REQUEST[ 'errtit' ]; + $error_message = $_REQUEST[ 'errmsg' ]; + + $error_result = array( + 'code' => -1, + 'title' => $error_title, + 'content' => $error_message + ); if( $wiki_id == -1 ) { - $result = array( 'code' => -1 ); + $result = $error_result; } else { $this->page_query_args[ 'pageid' ] = $wiki_id; $response = wp_remote_get( $wiki_url . '?' . http_build_query( $this->page_query_args ) ); @@ -90,7 +98,7 @@ public function ajax_get_wiki_page() { } } else { - $result = array( 'code' => -1 ); + $result = $error_result; } } @@ -112,7 +120,7 @@ public function get_wiki_page_info( $title = '', $wiki_url = '' ) { $result = array( 'wiki-id' => -1, - 'wiki-title' => __( 'Error!', 'wp-wiki-tooltip' ), + 'wiki-title' => '', 'wiki-url' => '' ); diff --git a/class.wp-wiki-tooltip.php b/class.wp-wiki-tooltip.php index 7676c98..9c40a37 100644 --- a/class.wp-wiki-tooltip.php +++ b/class.wp-wiki-tooltip.php @@ -24,11 +24,11 @@ public function __construct() { } public function init() { - wp_enqueue_style( 'tooltipster-css', plugins_url( 'static/external/tooltipster/css/tooltipster.css', __FILE__ ), array(), '3.0', 'all' ); - wp_enqueue_style( 'tooltipster-light-css', plugins_url( 'static/external/tooltipster/css/themes/tooltipster-light.css', __FILE__ ), array(), '3.0', 'all' ); - wp_enqueue_style( 'tooltipster-noir-css', plugins_url( 'static/external/tooltipster/css/themes/tooltipster-noir.css', __FILE__ ), array(), '3.0', 'all' ); - wp_enqueue_style( 'tooltipster-punk-css', plugins_url( 'static/external/tooltipster/css/themes/tooltipster-punk.css', __FILE__ ), array(), '3.0', 'all' ); - wp_enqueue_style( 'tooltipster-shadow-css', plugins_url( 'static/external/tooltipster/css/themes/tooltipster-shadow.css', __FILE__ ), array(), '3.0', 'all' ); + wp_enqueue_style( 'tooltipster-css', plugins_url( 'static/external/tooltipster/dist/css/tooltipster.bundle.min.css', __FILE__ ), array(), '4.2.5', 'all' ); + wp_enqueue_style( 'tooltipster-light-css', plugins_url( 'static/external/tooltipster/dist/css/plugins/tooltipster/sideTip/themes/tooltipster-sideTip-light.min.css', __FILE__ ), array(), '4.2.5', 'all' ); + wp_enqueue_style( 'tooltipster-noir-css', plugins_url( 'static/external/tooltipster/dist/css/plugins/tooltipster/sideTip/themes/tooltipster-sideTip-noir.min.css', __FILE__ ), array(), '4.2.5', 'all' ); + wp_enqueue_style( 'tooltipster-punk-css', plugins_url( 'static/external/tooltipster/dist/css/plugins/tooltipster/sideTip/themes/tooltipster-sideTip-punk.min.css', __FILE__ ), array(), '4.2.5', 'all' ); + wp_enqueue_style( 'tooltipster-shadow-css', plugins_url( 'static/external/tooltipster/dist/css/plugins/tooltipster/sideTip/themes/tooltipster-sideTip-shadow.min.css', __FILE__ ), array(), '4.2.5', 'all' ); wp_enqueue_style( 'wp-wiki-tooltip-css', plugins_url( 'static/css/wp-wiki-tooltip.css', __FILE__ ), array( 'tooltipster-css' ), $this->version, 'all' ); wp_add_inline_style( 'wp-wiki-tooltip-css', @@ -39,21 +39,25 @@ public function init() { 'div.wiki-tooltip-balloon img.thumb { ' . $this->options[ 'thumb-style' ] . ' }' ); - wp_enqueue_script( 'tooltipster-js', plugins_url( 'static/external/tooltipster/js/jquery.tooltipster.min.js', __FILE__ ), array( 'jquery' ), '3.0', false ); + wp_enqueue_script( 'tooltipster-js', plugins_url( 'static/external/tooltipster/dist/js/tooltipster.bundle.min.js', __FILE__ ), array( 'jquery' ), '3.0', false ); wp_register_script( 'wp-wiki-tooltip-js', plugins_url( 'static/js/wp-wiki-tooltip.js', __FILE__ ), array( 'tooltipster-js' ), $this->version, false ); wp_localize_script( 'wp-wiki-tooltip-js', 'wp_wiki_tooltip', array( 'wp_ajax_url' => admin_url( 'admin-ajax.php' ), 'wiki_plugin_url' => plugin_dir_url( __FILE__ ), 'tooltip_theme' => 'tooltipster-' . $this->options[ 'theme' ], 'footer_text' => __( 'Click here to open Wiki page...', 'wp-wiki-tooltip' ), - 'error_title' => __( 'Error!', 'wp-wiki-tooltip' ), - 'page_not_found_message' => __( 'Sorry, but we were not able to find this page :(', 'wp-wiki-tooltip' ), 'thumb_enable' => ( $this->options[ 'thumb-enable' ] == 'on' ) ? 'on' : 'off', 'thumb_width' => $this->options[ 'thumb-width' ], 'thumb_align' => $this->options[ 'thumb-align' ], - 'trigger' => $this->options[ 'trigger' ], + 'trigger' => $this->options[ 'trigger' ], + 'trigger_hover_action' => $this->options[ 'trigger-hover-action' ], 'a_target' => $this->options[ 'a-target' ], - 'min_screen_width' => $this->options[ 'min-screen-width' ] + 'min_screen_width' => $this->options[ 'min-screen-width' ], + 'error_handling' => $this->options[ 'error-handling' ], + 'default_error_title' => __( 'Error!', 'wp-wiki-tooltip' ), + 'default_error_message' => __( 'Sorry, but we were not able to find this page :(', 'wp-wiki-tooltip' ), + 'own_error_title' => $this->options[ 'own-error-title' ], + 'own_error_message' => $this->options[ 'own-error-message' ] )); wp_enqueue_script( 'wp-wiki-tooltip-js' ); } @@ -99,9 +103,13 @@ public function do_wiki_shortcode( $atts, $content ) { } $output = ''; - // $output .= '' . $content . ''; $relno = ( $this->options[ 'a-target' ] == '_blank' ) ? ' rel="noopener noreferrer"' : ''; - $output .= '' . $content . ''; + + if( ( $trans_wiki_data[ 'wiki-id' ] == '-1' ) && ( $this->options[ 'error-handling' ] == 'remove-link' ) ) { + $output .= $content; + } else { + $output .= '' . $content . ''; + } return $output; } diff --git a/config.php b/config.php index 4d33261..1449762 100644 --- a/config.php +++ b/config.php @@ -24,7 +24,15 @@ 'trigger' => 'hover', // what triggers the tooltip - 'min-screen-width' => '0', // active tooltips only if screen is greater than this number of pixel + 'trigger-hover-action' => 'none', // how does the link work if trigger is "hover" + + 'min-screen-width' => '0', // activate tooltips only if screen is greater than this number of pixel + + 'error-handling' => 'show-default', // how should errors be handled + + 'own-error-title' => '', // the self-defined title of the error message + + 'own-error-message' => '', // the self-defined message of the error message 'theme' => 'default', // use default theme of Tooltipster diff --git a/languages/wp-wiki-tooltip-de_DE.mo b/languages/wp-wiki-tooltip-de_DE.mo index 292e0c6..089a875 100644 Binary files a/languages/wp-wiki-tooltip-de_DE.mo and b/languages/wp-wiki-tooltip-de_DE.mo differ diff --git a/languages/wp-wiki-tooltip-de_DE.po b/languages/wp-wiki-tooltip-de_DE.po index 7a12198..336cbc0 100644 --- a/languages/wp-wiki-tooltip-de_DE.po +++ b/languages/wp-wiki-tooltip-de_DE.po @@ -1,7 +1,7 @@ msgid "" msgstr "" "Project-Id-Version: WP Wiki Tooltip 0.1\n" -"POT-Creation-Date: 2017-06-11 09:58+0200\n" +"POT-Creation-Date: 2018-02-23 00:12+0100\n" "PO-Revision-Date: \n" "Last-Translator: Nico Danneberg
-
- Soufflé chocolate cake powder. Applicake lollipop oat cake gingerbread.
'), - // setting a same value to minWidth and maxWidth will result in a fixed width - minWidth: 300, - maxWidth: 300, - position: 'right' - }); - $('#demo-theme').tooltipster({ - animation: 'grow', - theme: 'tooltipster-pink' - }); - $('#demo-callback').tooltipster({ - content: 'Loading...', - updateAnimation: false, - functionBefore: function(origin, continueTooltip) { - continueTooltip(); - - if (origin.data('ajax') !== 'cached') { - - $.jGFeed('http://ws.audioscrobbler.com/2.0/user/ce3ge/recenttracks.rss?', - function(feeds){ - var content = ''; - if(!feeds){ - content = 'Woops - there was an error retrieving my last.fm RSS feed'; - origin.tooltipster('content', content); - } - else { - content = $('I last listened to: ' + feeds.entries[0].title + ''); - origin - .tooltipster('content', content) - .data('ajax', 'cached'); - } - }, 10); - - origin.data('ajax', 'cached'); - } - }, - functionAfter: function(origin) { - alert('The tooltip has closed!'); - } - }); - $('#demo-events').tooltipster({ - trigger: 'click' - }); - $(window).keypress(function() { - $('#demo-events').tooltipster('hide'); - }); - $('#demo-interact').tooltipster({ - contentAsHTML: true, - interactive: true - }); - $('#demo-touch').tooltipster({ - touchDevices: false - }); - $('#demo-icon').tooltipster({ - iconDesktop: true, - iconTouch: true - }); - $('#demo-multiple').tooltipster({ - animation: 'swing', - content: 'North', - multiple: true, - position: 'top' - }); - $('#demo-multiple').tooltipster({ - content: 'East', - multiple: true, - position: 'right', - theme: 'tooltipster-punk' - }); - $('#demo-multiple').tooltipster({ - animation: 'grow', - content: 'South', - delay: 200, - multiple: true, - position: 'bottom', - theme: 'tooltipster-light' - }); - $('#demo-multiple').tooltipster({ - animation: 'fall', - content: 'West', - multiple: true, - position: 'left', - theme: 'tooltipster-shadow' - }); - $('.tooltipster-light-preview').tooltipster({ - theme: 'tooltipster-light' - }); - $('.tooltipster-punk-preview').tooltipster({ - theme: 'tooltipster-punk' - }); - $('.tooltipster-noir-preview').tooltipster({ - theme: 'tooltipster-noir' - }); - $('.tooltipster-shadow-preview').tooltipster({ - theme: 'tooltipster-shadow' - }); - - $('header select').change(function() { - var goTo = $(this).val(); - var section = $('#'+goTo); - var offset = section.offset().top; - $('html, body').scrollTop(offset); - }); - - prettyPrint(); - - -}); \ No newline at end of file diff --git a/static/external/tooltipster/index.html b/static/external/tooltipster/index.html deleted file mode 100644 index 29b17c2..0000000 --- a/static/external/tooltipster/index.html +++ /dev/null @@ -1,731 +0,0 @@ - - - -
- 
-
-
-
-
-
-
-
-
-
- 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/static/external/tooltipster/js/jquery.tooltipster.js b/static/external/tooltipster/js/jquery.tooltipster.js
deleted file mode 100644
index 60171db..0000000
--- a/static/external/tooltipster/js/jquery.tooltipster.js
+++ /dev/null
@@ -1,1327 +0,0 @@
-/*
-
-Tooltipster 3.3.0 | 2014-11-08
-A rockin' custom tooltip jQuery plugin
-
-Developed by Caleb Jacob under the MIT license http://opensource.org/licenses/MIT
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-*/
-
-;(function ($, window, document) {
-
- var pluginName = "tooltipster",
- defaults = {
- animation: 'fade',
- arrow: true,
- arrowColor: '',
- autoClose: true,
- content: null,
- contentAsHTML: false,
- contentCloning: true,
- debug: true,
- delay: 200,
- minWidth: 0,
- maxWidth: null,
- functionInit: function(origin, content) {},
- functionBefore: function(origin, continueTooltip) {
- continueTooltip();
- },
- functionReady: function(origin, tooltip) {},
- functionAfter: function(origin) {},
- hideOnClick: false,
- icon: '(?)',
- iconCloning: true,
- iconDesktop: false,
- iconTouch: false,
- iconTheme: 'tooltipster-icon',
- interactive: false,
- interactiveTolerance: 350,
- multiple: false,
- offsetX: 0,
- offsetY: 0,
- onlyOne: false,
- position: 'top',
- positionTracker: false,
- positionTrackerCallback: function(origin){
- // the default tracker callback will close the tooltip when the trigger is
- // 'hover' (see https://github.com/iamceege/tooltipster/pull/253)
- if(this.option('trigger') == 'hover' && this.option('autoClose')) {
- this.hide();
- }
- },
- restoration: 'current',
- speed: 350,
- timer: 0,
- theme: 'tooltipster-default',
- touchDevices: true,
- trigger: 'hover',
- updateAnimation: true
- };
-
- function Plugin(element, options) {
-
- // list of instance variables
-
- this.bodyOverflowX;
- // stack of custom callbacks provided as parameters to API methods
- this.callbacks = {
- hide: [],
- show: []
- };
- this.checkInterval = null;
- // this will be the user content shown in the tooltip. A capital "C" is used because there is also a method called content()
- this.Content;
- // this is the original element which is being applied the tooltipster plugin
- this.$el = $(element);
- // this will be the element which triggers the appearance of the tooltip on hover/click/custom events.
- // it will be the same as this.$el if icons are not used (see in the options), otherwise it will correspond to the created icon
- this.$elProxy;
- this.elProxyPosition;
- this.enabled = true;
- this.options = $.extend({}, defaults, options);
- this.mouseIsOverProxy = false;
- // a unique namespace per instance, for easy selective unbinding
- this.namespace = 'tooltipster-'+ Math.round(Math.random()*100000);
- // Status (capital S) can be either : appearing, shown, disappearing, hidden
- this.Status = 'hidden';
- this.timerHide = null;
- this.timerShow = null;
- // this will be the tooltip element (jQuery wrapped HTML element)
- this.$tooltip;
-
- // for backward compatibility
- this.options.iconTheme = this.options.iconTheme.replace('.', '');
- this.options.theme = this.options.theme.replace('.', '');
-
- // launch
-
- this._init();
- }
-
- Plugin.prototype = {
-
- _init: function() {
-
- var self = this;
-
- // disable the plugin on old browsers (including IE7 and lower)
- if (document.querySelector) {
-
- // note : the content is null (empty) by default and can stay that way if the plugin remains initialized but not fed any content. The tooltip will just not appear.
-
- // let's save the initial value of the title attribute for later restoration if need be.
- var initialTitle = null;
- // it will already have been saved in case of multiple tooltips
- if (self.$el.data('tooltipster-initialTitle') === undefined) {
-
- initialTitle = self.$el.attr('title');
-
- // we do not want initialTitle to have the value "undefined" because of how jQuery's .data() method works
- if (initialTitle === undefined) initialTitle = null;
-
- self.$el.data('tooltipster-initialTitle', initialTitle);
- }
-
- // if content is provided in the options, its has precedence over the title attribute.
- // Note : an empty string is considered content, only 'null' represents the absence of content.
- // Also, an existing title="" attribute will result in an empty string content
- if (self.options.content !== null){
- self._content_set(self.options.content);
- }
- else {
- self._content_set(initialTitle);
- }
-
- var c = self.options.functionInit.call(self.$el, self.$el, self.Content);
- if(typeof c !== 'undefined') self._content_set(c);
-
- self.$el
- // strip the title off of the element to prevent the default tooltips from popping up
- .removeAttr('title')
- // to be able to find all instances on the page later (upon window events in particular)
- .addClass('tooltipstered');
-
- // detect if we're changing the tooltip origin to an icon
- // note about this condition : if the device has touch capability and self.options.iconTouch is false, you'll have no icons event though you may consider your device as a desktop if it also has a mouse. Not sure why someone would have this use case though.
- if ((!deviceHasTouchCapability && self.options.iconDesktop) || (deviceHasTouchCapability && self.options.iconTouch)) {
-
- // TODO : the tooltip should be automatically be given an absolute position to be near the origin. Otherwise, when the origin is floating or what, it's going to be nowhere near it and disturb the position flow of the page elements. It will imply that the icon also detects when its origin moves, to follow it : not trivial.
- // Until it's done, the icon feature does not really make sense since the user still has most of the work to do by himself
-
- // if the icon provided is in the form of a string
- if(typeof self.options.icon === 'string'){
- // wrap it in a span with the icon class
- self.$elProxy = $('');
- self.$elProxy.text(self.options.icon);
- }
- // if it is an object (sensible choice)
- else {
- // (deep) clone the object if iconCloning == true, to make sure every instance has its own proxy. We use the icon without wrapping, no need to. We do not give it a class either, as the user will undoubtedly style the object on his own and since our css properties may conflict with his own
- if (self.options.iconCloning) self.$elProxy = self.options.icon.clone(true);
- else self.$elProxy = self.options.icon;
- }
-
- self.$elProxy.insertAfter(self.$el);
- }
- else {
- self.$elProxy = self.$el;
- }
-
- // for 'click' and 'hover' triggers : bind on events to open the tooltip. Closing is now handled in _showNow() because of its bindings.
- // Notes about touch events :
- // - mouseenter, mouseleave and clicks happen even on pure touch devices because they are emulated. deviceIsPureTouch() is a simple attempt to detect them.
- // - on hybrid devices, we do not prevent touch gesture from opening tooltips. It would be too complex to differentiate real mouse events from emulated ones.
- // - we check deviceIsPureTouch() at each event rather than prior to binding because the situation may change during browsing
- if (self.options.trigger == 'hover') {
-
- // these binding are for mouse interaction only
- self.$elProxy
- .on('mouseenter.'+ self.namespace, function() {
- if (!deviceIsPureTouch() || self.options.touchDevices) {
- self.mouseIsOverProxy = true;
- self._show();
- }
- })
- .on('mouseleave.'+ self.namespace, function() {
- if (!deviceIsPureTouch() || self.options.touchDevices) {
- self.mouseIsOverProxy = false;
- }
- });
-
- // for touch interaction only
- if (deviceHasTouchCapability && self.options.touchDevices) {
-
- // for touch devices, we immediately display the tooltip because we cannot rely on mouseleave to handle the delay
- self.$elProxy.on('touchstart.'+ self.namespace, function() {
- self._showNow();
- });
- }
- }
- else if (self.options.trigger == 'click') {
-
- // note : for touch devices, we do not bind on touchstart, we only rely on the emulated clicks (triggered by taps)
- self.$elProxy.on('click.'+ self.namespace, function() {
- if (!deviceIsPureTouch() || self.options.touchDevices) {
- self._show();
- }
- });
- }
- }
- },
-
- // this function will schedule the opening of the tooltip after the delay, if there is one
- _show: function() {
-
- var self = this;
-
- if (self.Status != 'shown' && self.Status != 'appearing') {
-
- if (self.options.delay) {
- self.timerShow = setTimeout(function(){
-
- // for hover trigger, we check if the mouse is still over the proxy, otherwise we do not show anything
- if (self.options.trigger == 'click' || (self.options.trigger == 'hover' && self.mouseIsOverProxy)) {
- self._showNow();
- }
- }, self.options.delay);
- }
- else self._showNow();
- }
- },
-
- // this function will open the tooltip right away
- _showNow: function(callback) {
-
- var self = this;
-
- // call our constructor custom function before continuing
- self.options.functionBefore.call(self.$el, self.$el, function() {
-
- // continue only if the tooltip is enabled and has any content
- if (self.enabled && self.Content !== null) {
-
- // save the method callback and cancel hide method callbacks
- if (callback) self.callbacks.show.push(callback);
- self.callbacks.hide = [];
-
- //get rid of any appearance timer
- clearTimeout(self.timerShow);
- self.timerShow = null;
- clearTimeout(self.timerHide);
- self.timerHide = null;
-
- // if we only want one tooltip open at a time, close all auto-closing tooltips currently open and not already disappearing
- if (self.options.onlyOne) {
- $('.tooltipstered').not(self.$el).each(function(i,el) {
-
- var $el = $(el),
- nss = $el.data('tooltipster-ns');
-
- // iterate on all tooltips of the element
- $.each(nss, function(i, ns){
- var instance = $el.data(ns),
- // we have to use the public methods here
- s = instance.status(),
- ac = instance.option('autoClose');
-
- if (s !== 'hidden' && s !== 'disappearing' && ac) {
- instance.hide();
- }
- });
- });
- }
-
- var finish = function() {
- self.Status = 'shown';
-
- // trigger any show method custom callbacks and reset them
- $.each(self.callbacks.show, function(i,c) { c.call(self.$el); });
- self.callbacks.show = [];
- };
-
- // if this origin already has its tooltip open
- if (self.Status !== 'hidden') {
-
- // the timer (if any) will start (or restart) right now
- var extraTime = 0;
-
- // if it was disappearing, cancel that
- if (self.Status === 'disappearing') {
-
- self.Status = 'appearing';
-
- if (supportsTransitions()) {
-
- self.$tooltip
- .clearQueue()
- .removeClass('tooltipster-dying')
- .addClass('tooltipster-'+ self.options.animation +'-show');
-
- if (self.options.speed > 0) self.$tooltip.delay(self.options.speed);
-
- self.$tooltip.queue(finish);
- }
- else {
- // in case the tooltip was currently fading out, bring it back to life
- self.$tooltip
- .stop()
- .fadeIn(finish);
- }
- }
- // if the tooltip is already open, we still need to trigger the method custom callback
- else if(self.Status === 'shown') {
- finish();
- }
- }
- // if the tooltip isn't already open, open that sucker up!
- else {
-
- self.Status = 'appearing';
-
- // the timer (if any) will start when the tooltip has fully appeared after its transition
- var extraTime = self.options.speed;
-
- // disable horizontal scrollbar to keep overflowing tooltips from jacking with it and then restore it to its previous value
- self.bodyOverflowX = $('body').css('overflow-x');
- $('body').css('overflow-x', 'hidden');
-
- // get some other settings related to building the tooltip
- var animation = 'tooltipster-' + self.options.animation,
- animationSpeed = '-webkit-transition-duration: '+ self.options.speed +'ms; -webkit-animation-duration: '+ self.options.speed +'ms; -moz-transition-duration: '+ self.options.speed +'ms; -moz-animation-duration: '+ self.options.speed +'ms; -o-transition-duration: '+ self.options.speed +'ms; -o-animation-duration: '+ self.options.speed +'ms; -ms-transition-duration: '+ self.options.speed +'ms; -ms-animation-duration: '+ self.options.speed +'ms; transition-duration: '+ self.options.speed +'ms; animation-duration: '+ self.options.speed +'ms;',
- minWidth = self.options.minWidth ? 'min-width:'+ Math.round(self.options.minWidth) +'px;' : '',
- maxWidth = self.options.maxWidth ? 'max-width:'+ Math.round(self.options.maxWidth) +'px;' : '',
- pointerEvents = self.options.interactive ? 'pointer-events: auto;' : '';
-
- // build the base of our tooltip
- self.$tooltip = $('');
-
- // only add the animation class if the user has a browser that supports animations
- if (supportsTransitions()) self.$tooltip.addClass(animation);
-
- // insert the content
- self._content_insert();
-
- // attach
- self.$tooltip.appendTo('body');
-
- // do all the crazy calculations and positioning
- self.reposition();
-
- // call our custom callback since the content of the tooltip is now part of the DOM
- self.options.functionReady.call(self.$el, self.$el, self.$tooltip);
-
- // animate in the tooltip
- if (supportsTransitions()) {
-
- self.$tooltip.addClass(animation + '-show');
-
- if(self.options.speed > 0) self.$tooltip.delay(self.options.speed);
-
- self.$tooltip.queue(finish);
- }
- else {
- self.$tooltip.css('display', 'none').fadeIn(self.options.speed, finish);
- }
-
- // will check if our tooltip origin is removed while the tooltip is shown
- self._interval_set();
-
- // reposition on scroll (otherwise position:fixed element's tooltips will move away form their origin) and on resize (in case position can/has to be changed)
- $(window).on('scroll.'+ self.namespace +' resize.'+ self.namespace, function() {
- self.reposition();
- });
-
- // auto-close bindings
- if (self.options.autoClose) {
-
- // in case a listener is already bound for autoclosing (mouse or touch, hover or click), unbind it first
- $('body').off('.'+ self.namespace);
-
- // here we'll have to set different sets of bindings for both touch and mouse
- if (self.options.trigger == 'hover') {
-
- // if the user touches the body, hide
- if (deviceHasTouchCapability) {
- // timeout 0 : explanation below in click section
- setTimeout(function() {
- // we don't want to bind on click here because the initial touchstart event has not yet triggered its click event, which is thus about to happen
- $('body').on('touchstart.'+ self.namespace, function() {
- self.hide();
- });
- }, 0);
- }
-
- // if we have to allow interaction
- if (self.options.interactive) {
-
- // touch events inside the tooltip must not close it
- if (deviceHasTouchCapability) {
- self.$tooltip.on('touchstart.'+ self.namespace, function(event) {
- event.stopPropagation();
- });
- }
-
- // as for mouse interaction, we get rid of the tooltip only after the mouse has spent some time out of it
- var tolerance = null;
-
- self.$elProxy.add(self.$tooltip)
- // hide after some time out of the proxy and the tooltip
- .on('mouseleave.'+ self.namespace + '-autoClose', function() {
- clearTimeout(tolerance);
- tolerance = setTimeout(function(){
- self.hide();
- }, self.options.interactiveTolerance);
- })
- // suspend timeout when the mouse is over the proxy or the tooltip
- .on('mouseenter.'+ self.namespace + '-autoClose', function() {
- clearTimeout(tolerance);
- });
- }
- // if this is a non-interactive tooltip, get rid of it if the mouse leaves
- else {
- self.$elProxy.on('mouseleave.'+ self.namespace + '-autoClose', function() {
- self.hide();
- });
- }
-
- // close the tooltip when the proxy gets a click (common behavior of native tooltips)
- if (self.options.hideOnClick) {
-
- self.$elProxy.on('click.'+ self.namespace + '-autoClose', function() {
- self.hide();
- });
- }
- }
- // here we'll set the same bindings for both clicks and touch on the body to hide the tooltip
- else if(self.options.trigger == 'click'){
-
- // use a timeout to prevent immediate closing if the method was called on a click event and if options.delay == 0 (because of bubbling)
- setTimeout(function() {
- $('body').on('click.'+ self.namespace +' touchstart.'+ self.namespace, function() {
- self.hide();
- });
- }, 0);
-
- // if interactive, we'll stop the events that were emitted from inside the tooltip to stop autoClosing
- if (self.options.interactive) {
-
- // note : the touch events will just not be used if the plugin is not enabled on touch devices
- self.$tooltip.on('click.'+ self.namespace +' touchstart.'+ self.namespace, function(event) {
- event.stopPropagation();
- });
- }
- }
- }
- }
-
- // if we have a timer set, let the countdown begin
- if (self.options.timer > 0) {
-
- self.timerHide = setTimeout(function() {
- self.timerHide = null;
- self.hide();
- }, self.options.timer + extraTime);
- }
- }
- });
- },
-
- _interval_set: function() {
-
- var self = this;
-
- self.checkInterval = setInterval(function() {
-
- // if the tooltip and/or its interval should be stopped
- if (
- // if the origin has been removed
- $('body').find(self.$el).length === 0
- // if the elProxy has been removed
- || $('body').find(self.$elProxy).length === 0
- // if the tooltip has been closed
- || self.Status == 'hidden'
- // if the tooltip has somehow been removed
- || $('body').find(self.$tooltip).length === 0
- ) {
- // remove the tooltip if it's still here
- if (self.Status == 'shown' || self.Status == 'appearing') self.hide();
-
- // clear this interval as it is no longer necessary
- self._interval_cancel();
- }
- // if everything is alright
- else {
- // compare the former and current positions of the elProxy to reposition the tooltip if need be
- if(self.options.positionTracker){
-
- var p = self._repositionInfo(self.$elProxy),
- identical = false;
-
- // compare size first (a change requires repositioning too)
- if(areEqual(p.dimension, self.elProxyPosition.dimension)){
-
- // for elements with a fixed position, we track the top and left properties (relative to window)
- if(self.$elProxy.css('position') === 'fixed'){
- if(areEqual(p.position, self.elProxyPosition.position)) identical = true;
- }
- // otherwise, track total offset (relative to document)
- else {
- if(areEqual(p.offset, self.elProxyPosition.offset)) identical = true;
- }
- }
-
- if(!identical){
- self.reposition();
- self.options.positionTrackerCallback.call(self, self.$el);
- }
- }
- }
- }, 200);
- },
-
- _interval_cancel: function() {
- clearInterval(this.checkInterval);
- // clean delete
- this.checkInterval = null;
- },
-
- _content_set: function(content) {
- // clone if asked. Cloning the object makes sure that each instance has its own version of the content (in case a same object were provided for several instances)
- // reminder : typeof null === object
- if (typeof content === 'object' && content !== null && this.options.contentCloning) {
- content = content.clone(true);
- }
- this.Content = content;
- },
-
- _content_insert: function() {
-
- var self = this,
- $d = this.$tooltip.find('.tooltipster-content');
-
- if (typeof self.Content === 'string' && !self.options.contentAsHTML) {
- $d.text(self.Content);
- }
- else {
- $d
- .empty()
- .append(self.Content);
- }
- },
-
- _update: function(content) {
-
- var self = this;
-
- // change the content
- self._content_set(content);
-
- if (self.Content !== null) {
-
- // update the tooltip if it is open
- if (self.Status !== 'hidden') {
-
- // reset the content in the tooltip
- self._content_insert();
-
- // reposition and resize the tooltip
- self.reposition();
-
- // if we want to play a little animation showing the content changed
- if (self.options.updateAnimation) {
-
- if (supportsTransitions()) {
-
- self.$tooltip.css({
- 'width': '',
- '-webkit-transition': 'all ' + self.options.speed + 'ms, width 0ms, height 0ms, left 0ms, top 0ms',
- '-moz-transition': 'all ' + self.options.speed + 'ms, width 0ms, height 0ms, left 0ms, top 0ms',
- '-o-transition': 'all ' + self.options.speed + 'ms, width 0ms, height 0ms, left 0ms, top 0ms',
- '-ms-transition': 'all ' + self.options.speed + 'ms, width 0ms, height 0ms, left 0ms, top 0ms',
- 'transition': 'all ' + self.options.speed + 'ms, width 0ms, height 0ms, left 0ms, top 0ms'
- }).addClass('tooltipster-content-changing');
-
- // reset the CSS transitions and finish the change animation
- setTimeout(function() {
-
- if(self.Status != 'hidden'){
-
- self.$tooltip.removeClass('tooltipster-content-changing');
-
- // after the changing animation has completed, reset the CSS transitions
- setTimeout(function() {
-
- if(self.Status !== 'hidden'){
- self.$tooltip.css({
- '-webkit-transition': self.options.speed + 'ms',
- '-moz-transition': self.options.speed + 'ms',
- '-o-transition': self.options.speed + 'ms',
- '-ms-transition': self.options.speed + 'ms',
- 'transition': self.options.speed + 'ms'
- });
- }
- }, self.options.speed);
- }
- }, self.options.speed);
- }
- else {
- self.$tooltip.fadeTo(self.options.speed, 0.5, function() {
- if(self.Status != 'hidden'){
- self.$tooltip.fadeTo(self.options.speed, 1);
- }
- });
- }
- }
- }
- }
- else {
- self.hide();
- }
- },
-
- _repositionInfo: function($el) {
- return {
- dimension: {
- height: $el.outerHeight(false),
- width: $el.outerWidth(false)
- },
- offset: $el.offset(),
- position: {
- left: parseInt($el.css('left')),
- top: parseInt($el.css('top'))
- }
- };
- },
-
- hide: function(callback) {
-
- var self = this;
-
- // save the method custom callback and cancel any show method custom callbacks
- if (callback) self.callbacks.hide.push(callback);
- self.callbacks.show = [];
-
- // get rid of any appearance timeout
- clearTimeout(self.timerShow);
- self.timerShow = null;
- clearTimeout(self.timerHide);
- self.timerHide = null;
-
- var finishCallbacks = function() {
- // trigger any hide method custom callbacks and reset them
- $.each(self.callbacks.hide, function(i,c) { c.call(self.$el); });
- self.callbacks.hide = [];
- };
-
- // hide
- if (self.Status == 'shown' || self.Status == 'appearing') {
-
- self.Status = 'disappearing';
-
- var finish = function() {
-
- self.Status = 'hidden';
-
- // detach our content object first, so the next jQuery's remove() call does not unbind its event handlers
- if (typeof self.Content == 'object' && self.Content !== null) {
- self.Content.detach();
- }
-
- self.$tooltip.remove();
- self.$tooltip = null;
-
- // unbind orientationchange, scroll and resize listeners
- $(window).off('.'+ self.namespace);
-
- $('body')
- // unbind any auto-closing click/touch listeners
- .off('.'+ self.namespace)
- .css('overflow-x', self.bodyOverflowX);
-
- // unbind any auto-closing click/touch listeners
- $('body').off('.'+ self.namespace);
-
- // unbind any auto-closing hover listeners
- self.$elProxy.off('.'+ self.namespace + '-autoClose');
-
- // call our constructor custom callback function
- self.options.functionAfter.call(self.$el, self.$el);
-
- // call our method custom callbacks functions
- finishCallbacks();
- };
-
- if (supportsTransitions()) {
-
- self.$tooltip
- .clearQueue()
- .removeClass('tooltipster-' + self.options.animation + '-show')
- // for transitions only
- .addClass('tooltipster-dying');
-
- if(self.options.speed > 0) self.$tooltip.delay(self.options.speed);
-
- self.$tooltip.queue(finish);
- }
- else {
- self.$tooltip
- .stop()
- .fadeOut(self.options.speed, finish);
- }
- }
- // if the tooltip is already hidden, we still need to trigger the method custom callback
- else if(self.Status == 'hidden') {
- finishCallbacks();
- }
-
- return self;
- },
-
- // the public show() method is actually an alias for the private showNow() method
- show: function(callback) {
- this._showNow(callback);
- return this;
- },
-
- // 'update' is deprecated in favor of 'content' but is kept for backward compatibility
- update: function(c) {
- return this.content(c);
- },
- content: function(c) {
- // getter method
- if(typeof c === 'undefined'){
- return this.Content;
- }
- // setter method
- else {
- this._update(c);
- return this;
- }
- },
-
- reposition: function() {
-
- var self = this;
-
- // in case the tooltip has been removed from DOM manually
- if ($('body').find(self.$tooltip).length !== 0) {
-
- // reset width
- self.$tooltip.css('width', '');
-
- // find variables to determine placement
- self.elProxyPosition = self._repositionInfo(self.$elProxy);
- var arrowReposition = null,
- windowWidth = $(window).width(),
- // shorthand
- proxy = self.elProxyPosition,
- tooltipWidth = self.$tooltip.outerWidth(false),
- tooltipInnerWidth = self.$tooltip.innerWidth() + 1, // this +1 stops FireFox from sometimes forcing an additional text line
- tooltipHeight = self.$tooltip.outerHeight(false);
-
- // if this is an tag inside a
- A powerful, flexible jQuery plugin enabling you to easily create semantic, modern tooltips enhanced with the power of CSS.
--
-
-
-
-
- -
-
-
- -
-
-
- -
-
-
- -
-
-
-
Demos
--
-
- - Hover Default settings - -
- - Hover Fixed width, position, & HTML - -
- - Click Custom show / hide triggers - -
- - Hover Disable touch devices - -
- - Hover Custom themes & animations - -
- - Hover Custom callbacks (AJAX <3) - -
- - Hover Interaction with tooltips - -
- - Attach tooltips to icons - -
- - Hover Multiple tooltips on a single element - -
- ...& more! -
Getting Started
-1. Load jQuery and include Tooltipster's plugin files
-After you download Tooltipster, move tooltipster.css and jquery.tooltipster.min.js to your root's CSS and JavaScript directories. Next, load jQuery and include Tooltipster's CSS and JavaScript files inside of your tags:
--<head> -... - - <link rel="stylesheet" type="text/css" href="css/tooltipster.css" /> - - <script type="text/javascript" src="http://code.jquery.com/jquery-1.7.0.min.js"></script> - <script type="text/javascript" src="js/jquery.tooltipster.min.js"></script> - -... -</head> --
2. Set up your HTML
-In order for Tooltipster to work, we first need to add the .tooltip class (or whatever class / means of selection you'd like to use) to whatever element we wish to have a tooltip. Next, we'll set the title attribute to whatever we'd like our tooltip to say. Here are a few examples:
-Adding a tooltip to an image:
--<img src="my-image.png" class="tooltip" title="This is my image's tooltip message!" />-
Adding a tooltip to a link that already has a class:
--<a href="http://calebjacob.com" class="ketchup tooltip" title="This is my link's tooltip message!">Link</a>-
Adding a tooltip to a div:
--<div class="tooltip" title="This is my div's tooltip message!"> - This div has a tooltip when you hover over it! -</div>- -
3. Activate Tooltipster
-The last thing we have to do is activate the plugin. To do this, add the following script right before your closing </head> tag (using whatever selector you'd like - in this case we're using the .tooltip class):
-
-<head>
-
- ...
-
- <script>
- $(document).ready(function() {
- $('.tooltip').tooltipster();
- });
- </script>
-</head>
-
- 4. Taking It a Step Further
-Using HTML tags inside your tooltips
-Tooltipster allows you to use any HTML markup you can think of inside your tooltips. This means you can insert things like images and text formatting tags. To achieve this, the recommended method is a little different : provide your content as a jQuery object in the script rather than in the title attribute :
-
-<head>
-
- ...
-
- <script>
- $(document).ready(function() {
- $('#my-tooltip').tooltipster({
- content: $('<span><img src="my-image.png" /> <strong>This text is in bold case !</strong></span>')
- });
- });
- </script>
-</head>
-<body>
-
- <div id="my-tooltip">
- This div has a tooltip with HTML when you hover over it!
- </div>
-
-</body>
-
- Another (less recommended) way of achieving this is to put encoded HTML markup directly in your title attribute and set the 'contentAsHTML' option to 'true'. In all cases, make sure you have tight control over the content you wish to display in the tooltip, as unwanted <script> or <iframe> tags for example would be a serious security issue for your website.
- -
-<head>
-
- ...
-
- <script>
- $(document).ready(function() {
- $('.tooltip').tooltipster({
- contentAsHTML: true
- });
- });
- </script>
-</head>
-<body>
-
- <div class="tooltip" title="<img src="my-image.png" /> <strong> This text is in bold case !</strong>">
- This div has a tooltip with HTML when you hover over it!
- </div>
-
-</body>
-
- Customizing Your Tooltipster's Style
-The style of your Tooltipsters can be easily changed by editing/overriding the default Tooltipster theme, located in the css/tooltipster.css file.
-Tooltipster is also packaged with 4 alternative themes to choose from. They are demonstrated at the bottom of this page. To use a theme, just include its css file (located in the css/themes folder) in your page and specify its name in Tooltipster's settings :
-
-$('.tooltip').tooltipster({
- theme: 'tooltipster-noir'
-});
- And of course, you also have the option to create a brand new theme to suit your needs. To do this, start with the example below and add your flair. When you are done, include and specify your theme just like you would for one of Tooltipster's existing themes.
-
-/* This is how you would create a theme called "my-custom-theme": */
-
-.my-custom-theme {
- border-radius: 5px;
- border: 2px solid #000;
- background: #4c4c4c;
- color: #fff;
-}
-/* Use this next selector to style things like font-size and line-height: */
-.my-custom-theme .tooltipster-content {
- font-family: Arial, sans-serif;
- font-size: 14px;
- line-height: 16px;
- padding: 8px 10px;
-}
-
- Customizing Tooltipster's Functionality
-Tooltipster's options gives you a wide range of variables to tweak your tooltip to your heart's content. To learn more about all of the options, read the Options section. Here's just a few of the things you can play with:
-
-$('.tooltip').tooltipster({
- animation: 'fade',
- delay: 200,
- theme: 'tooltipster-default',
- touchDevices: false,
- trigger: 'hover'
-});
- Options
-animation |
- fade, grow, swing, slide, fall | -Determines how the tooltip will animate in and out. Feel free to modify or create custom transitions in the tooltipster.css file. In IE9 and 8, all animations default to a JavaScript generated, fade animation. Default: 'fade' | -
arrow |
- boolean | -Adds the "speech bubble arrow" to the tooltip. Default: true | -
arrowColor |
- hex code / rgb | -Select a specific color for the "speech bubble arrow". Default: will inherit the tooltip's background color | -
autoClose |
- boolean | -If autoClose is set to false, the tooltip will never close unless you call the 'hide' method yourself. Default: true | -
content |
- string, jQuery object | -If set, this will override the content of the tooltip. Default: null | -
contentAsHTML |
- boolean | -If the content of the tooltip is provided as a string, it is displayed as plain text by default. If this content should actually be interpreted as HTML, set this option to true. Default: false | -
contentCloning |
- boolean | -If you provide a jQuery object to the 'content' option, this sets if it is a clone of this object that should actually be used. Default: true | -
debug |
- boolean | -Tooltipster logs notices into the console when you're doing something you ideally shouldn't be doing. Set to false to disable logging. Default: true | -
delay |
- integer | -Delay how long it takes (in milliseconds) for the tooltip to start animating in. Default: 200 | -
minWidth |
- integer | -Set a minimum width for the tooltip. Default: 0 (auto width) | -
maxWidth |
- integer | -Set a maximum width for the tooltip. Default: null (no max width) | -
functionInit |
- function | -Create a custom function to be fired only once at instantiation. If the function returns a value, this value will become the content of the tooltip. See the advanced section to learn more. Default: function(origin, content) {} | -
functionBefore |
- function | -Create a custom function to be fired before the tooltip opens. This function may prevent or hold off the opening. See the advanced section to learn more. Default: function(origin, continueTooltip) { continueTooltip(); } | -
functionReady |
- function | -Create a custom function to be fired when the tooltip and its contents have been added to the DOM. Default: function(origin, tooltip) {} | -
functionAfter |
- function | -Create a custom function to be fired once the tooltip has been closed and removed from the DOM. Default: function(origin) {} | -
hideOnClick |
- boolean | -If true, the tooltip will close if its origin is clicked. This option only applies when 'trigger' is 'hover' and 'autoClose' is false. Default: false | -
icon |
- string, jQuery object | -If using the iconDesktop or iconTouch options, this sets the content for your icon. Default: '(?)' | -
iconCloning |
- boolean | -If you provide a jQuery object to the 'icon' option, this sets if it is a clone of this object that should actually be used. Default: true | -
iconDesktop |
- boolean | -Generate an icon next to your content that is responsible for activating the tooltip on non-touch devices. Default: false | -
iconTheme |
- CSS class | -If using the iconDesktop or iconTouch options, this sets the class on the icon (used to style the icon). Default: 'tooltipster-icon' | -
iconTouch |
- boolean | -Generate an icon next to your content that is responsible for activating the tooltip on touch devices (tablets, phones, etc). Default: false | -
interactive |
- boolean | -Give users the possibility to interact with the tooltip. Unless autoClose is set to false, the tooltip will still close if the user moves away from or clicks out of the tooltip. Default: false | -
interactiveTolerance |
- integer | -If the tooltip is interactive and activated by a hover event, set the amount of time (milliseconds) allowed for a user to hover off of the tooltip activator (origin) on to the tooltip itself - keeping the tooltip from closing. Default: 350 | -
multiple |
- boolean | -Allows you to put multiple tooltips on a single element. Read further instructions down this page. Default: false | -
offsetX |
- integer | -Offsets the tooltip (in pixels) farther left/right from the origin. Default: 0 | -
offsetY |
- integer | -Offsets the tooltip (in pixels) farther up/down from the origin. Default: 0 | -
onlyOne |
- boolean | -If true, only one tooltip will be allowed to be active at a time. Non-autoclosing tooltips will not be closed though. Default: false | -
position |
- right, left, top, top-right, top-left, bottom, bottom-right, bottom-left | -Set the position of the tooltip. Default: 'top' | -
positionTracker |
- boolean | -Will reposition the tooltip if the origin moves. As this option may have an impact on performance, we suggest you enable it only if you need to. Default: false | -
positionTrackerCallback |
- function | -Called after the tooltip has been repositioned by the position tracker (if enabled). Default: A function that will close the tooltip if the trigger is 'hover' and autoClose is false. | -
restoration |
- 'none', 'previous' or 'current' | -Specify if a TITLE attribute should be restored on the HTML element after a call to the 'destroy' method. This attribute may be omitted, or be restored with the value that existed before Tooltipster was initialized, or be restored with the stringified value of the current content. Note: in case of multiple tooltips on a single element, only the last destroyed tooltip may trigger a restoration. Default: 'current' | -
speed |
- integer | -Set the speed of the animation. Default: 350 | -
timer |
- integer | -How long the tooltip should be allowed to live before closing. Default: 0 (disabled) | -
theme |
- CSS class | -Set the theme used for your tooltip. Default: 'tooltipster-default' | -
touchDevices |
- boolean | -If set to false, tooltips will not show on pure-touch devices, unless you open them yourself with the 'show' method. Touch gestures on devices which also have a mouse will still open the tooltips though. Default: true | -
trigger |
- hover, click, custom | -Set how tooltips should be activated and closed. See the advanced section to learn how to build custom triggers. Default: 'hover' | -
updateAnimation |
- boolean | -If a tooltip is open while its content is updated, play a subtle animation when the content changes. Default: true | -
Advanced
- - -The awesomesauce Tooltipster API
-The Tooltipster API was created to be as flexible and easy to use as possible (thanks to glebtv for the inspiration). The API allows you to create custom triggers, update tooltip content on the fly (whether the tooltip is currently open or not), destroy Tooltipster functionality if needed, and reposition tooltips for unique use cases.
-Here is a quick look at all of the API methods:
-
-// set default options for all future tooltip instantiations
-$.fn.tooltipster('setDefaults', {
- position: 'bottom'
-});
-
-// show a tooltip (the 'callback' argument is optional)
-$(...).tooltipster('show', callback);
-
-// hide a tooltip (the 'callback' argument is optional)
-$(...).tooltipster('hide', callback);
-
-// temporarily disable a tooltip from being able to open
-$(...).tooltipster('disable');
-
-// if a tooltip was disabled from opening, reenable its previous functionality
-$(...).tooltipster('enable');
-
-// hide and destroy tooltip functionality
-$(...).tooltipster('destroy');
-
-// return a tooltip's current content (if selector contains multiple origins, only the value of the first will be returned)
-$(...).tooltipster('content');
-
-// update tooltip content
-$(...).tooltipster('content', myNewContent);
-
-// get the value of an option
-$(...).tooltipster('option', optionName);
-
-// set the value of an option (use at your own risk, we do not provide support for issues you may encounter when using this method)
-$(...).tooltipster('option', optionName, optionValue);
-
-// reposition and resize the tooltip
-$(...).tooltipster('reposition');
-
-// return the HTML root element of the tooltip
-$(...).tooltipster('elementTooltip');
-
-// return the HTML root element of the icon if there is one, 'undefined' otherwise
-$(...).tooltipster('elementIcon');
-
-
- Using AJAX to generate your tooltip content
-Tooltipster gives you the ability to fire a custom synchronous or asynchronous function everytime before the tooltip launches (functionBefore) or just once upon instantiation (functionInit). One great use for this is to grab dynamic content for your tooltips via AJAX.
-Here is an example of using functionBefore() asynchronously to replace a loading notification with our AJAX call. Once the content has been retrieved and updated, we'll take advantage of setting $.data() to keep our content cached for the next time the tooltip is opened:
-
-$('.tooltip').tooltipster({
- content: 'Loading...',
- functionBefore: function(origin, continueTooltip) {
-
- // we'll make this function asynchronous and allow the tooltip to go ahead and show the loading notification while fetching our data
- continueTooltip();
-
- // next, we want to check if our data has already been cached
- if (origin.data('ajax') !== 'cached') {
- $.ajax({
- type: 'POST',
- url: 'example.php',
- success: function(data) {
- // update our tooltip content with our returned data and cache it
- origin.tooltipster('content', data).data('ajax', 'cached');
- }
- });
- }
- }
-});
- However, maybe you just need to make one call and only need it to fire once instead of everytime the tooltip opens. This is where you could use functionInit(). This function will fire only once - right at the beginning of the instantiation process. You'll have the ability to do things like check the current content and set new content. Since the fancy API methods for returning and setting the value aren't instantiated yet, the way we go about this is a little different than functionBefore(): -
-$('.tooltip').tooltipster({
- functionInit: function(origin, content) {
-
- if (content === 'This is bad content') {
-
- // when the request has finished loading, we will change the tooltip's content
- $.ajax({
- type: 'POST',
- url: 'example.php',
- success: function(data) {
- origin.tooltipster('content', 'New content has been loaded : ' + data);
- }
- });
-
- // this returned string will overwrite the content of the tooltip for the time being
- return 'Wait while we load new content...';
- }
- else {
- // return nothing : the initialization continues normally with its content unchanged.
- }
- }
-});
-
-
- Manually show and hide a tooltip
-By default and according to the 'trigger' option, Tooltipster automatically shows tooltips upon users' mouse clicks or mouse hovering (or their touch-gesture equivalents). In addition to this, you may also manually open or close a tooltip at anytime with a simple javascript command.
-To achieve this, Tooltipster has the 'show' and 'hide' methods. Both of them may receive an optional 'callback' parameter, which represents a function you'd like to call when the tooltip is done animating.
-Here's an example of how you could launch a specific tooltip on page load and close it when any key on your keyboard is pressed. This will still preserve the default hover trigger.
--<span class="tooltip" id="example" title="My tooltip content">Example</span> --
-$(document).ready(function() {
-
- // first on page load, initiate the Tooltipster plugin
- $('.tooltip').tooltipster();
-
- // then immediately show the tooltip
- $('#example').tooltipster('show');
-
- // as soon as a key is pressed on the keyboard, hide the tooltip.
- $(window).keypress(function() {
- $('#example').tooltipster('hide');
- });
-});
-
- You may also provide a function as the callback parameter of the show/hide methods. The callback functions are called in the context of the tooltipstered element. If the tooltip is already in the state you are asking for (open/closed), the callback is executed immediately. Please note that if the show/hide action is somehow cancelled before it has completed its animation, the callback function will never be called.
-
-$(document).ready(function() {
-
- $('.tooltip').tooltipster();
-
- $('#example').tooltipster('show', function() {
- alert('The tooltip is now fully open. The content is: ' + this.tooltipster('content'));
- });
-
- $(window).keypress(function() {
- $('#example').tooltipster('hide', function() {
- alert('The tooltip is now fully closed');
- });
- });
-});
-
-
-
- Updating a tooltip's content
-It's easy as pie to update a tooltip's content - whether it's open or closed. Depending on your selector, you can update multiple tooltips at once or just one:
-
-$('#my-special-element').tooltipster('content', 'My new content');
- By default, Tooltipster will play a subtle animation when the content changes. To tweak the animation, check out the '.tooltipster-content-changing' class in your tooltipster.css file. It's important to note that only CSS transforms will be animated. To disable this animation, set updateAnimation to false.
- - -Using several tooltips on a single element
-Several independant tooltips can be set on a single element, each one having its own triggers and options. Just set the 'multiple' option to true when you initialize your tooltip. This will only change two things that you might want to be aware of.
-Firstly, the instantiation call will now return an array of Tooltipster objects generated by the call, instead of the tooltipped jQuery-wrapped elements.
-Secondly, you will have to use the Tooltipster object of a tooltip to make any API method calls on it. All methods documented on this page remain available, only the way to call them changes.
- -
-// create a first tooltip as usual. The multiple option is actually optional for the first tooltip
-$('#my-element').tooltipster({
- content: 'My first tooltip',
- position: 'top'
-});
-
-// instantiate a second tooltip and keep the returned Tooltipster objects array for later use of the API
-var tooltipsterObjects = $('#my-element').tooltipster({
- // don't forget to provide content here as the 1st tooltip will have deleted the original title attribute of the element
- content: 'My second tooltip',
- multiple: true,
- position: 'bottom'
-});
-
-// since the jQuery selector matches only one element, the array will contain only one Tooltipster object.
-// Otherwise the array would contain one object for each matched element, in the same order as them
-var tooltip2 = tooltipsterObjects[0];
-
-// use this Tooltipster object to make any API method call on the tooltip
-tooltip2.content('New content for my second tooltip').show();
-// all documented methods can be called that way
-var element = tooltip2.elementTooltip();
-
-// calling the API methods in the usual way only affects the first tooltip that was created on the element
-$('#my-element').tooltipster('content', 'New content for my first tooltip')
-
-
-
-// You may use the 'multiple' option on the first tooltip as well, it will return an array of objects too
-var tooltipsterObjects = $('#my-element').tooltipster({
- content: 'My first tooltip',
- multiple: true
-});
-
-// this is also a way to call API methods on the first tooltip
-var tooltip1 = tooltipsterObjects[0];
-tooltip1.content('New content for my first tooltip').show();
-
-Note : if you have multiple tooltips and destroy them, only the last destroyed tooltip will transfer its content back to the title attribute of the tooltipped element.
- - -Make tooltips accessible to persons with disabilities
-The W3C issued a recommendation to make websites more accessible to persons with disabilities. This recommendation is known as WAI-ARIA (or simply ARIA), which stands for Web Accessibility Initiative - Accessible Rich Internet Applications.
-Accessible tooltips can be powered by Tooltipster. To do this, one solution is to actually manipulate in parallel two tooltips which will share the same content :
- - the ARIA tooltip, which is invisible on the screen but readable by ARIA-compatible software
- - the Tooltipster tooltip, which is visible on the screen but does not appear as an ARIA-compatible element
-
A basic example : imagine that we want to put a tooltip on a text input field. As for the HTML part, you would write :
--<input id="myfield" type="text" aria-describedby="myfield_description" /> -<span id="myfield_description" role="tooltip">Please insert your name here</span> --
As for the CSS part, write this :
-
-#myfield_description {
- display: none;
-}
-
- And finally, you could initiate Tooltipster like this :
-
-$('#myfield').tooltipster({
- functionInit: function(){
- return $('#myfield_description').html();
- },
- functionReady: function(){
- $('#myfield_description').attr('aria-hidden', false);
- },
- functionAfter: function(){
- $('#myfield_description').attr('aria-hidden', true);
- }
-});
-
-// if in addition you want the tooltip to be displayed when the field gets focus, add these custom triggers :
-$('#myfield')
- .focus(function(){
- $(this).tooltipster('show');
- })
- .blur(function(){
- $(this).tooltipster('hide');
- });
-
-
- Community submitted use cases
-Using Tooltipster alongside jQuery Validate by sparky672
-Did you do something awesome with Tooltipster? Tell me and I'll post it up here!
-Themes
-Tired of the same old? Four other rocking themes are available for your tooltips, and you can always create yours ! Share them with us on GitHub !
-
- Default
- Light
- Punk
- Noir
- Shadow
-
- Talk
-Share thoughts, questions, & bugs!
-Head on over to Tooltipster's issue tracker on GitHub: https://github.com/iamceege/tooltipster/issues
-Before opening a new issue, please be sure to search through the backlog to see if your question or bug has been / is being resolved. Thank you! :)
-