Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

tipSwift is a jQuery plugin used to display inline tips & dialogs

branch: master
README.md

TipSwift

TipSwift is a tiny jQuery plugin for displaying tooltips and inline context-based dialog boxes ranging from prompts to confirmations for an ultra-sexy user interface.

TipSwift has started as a port of swift to tipsy. The tipsy library was required to use TipSwift v1.

As of v2, TipSwift integrates its own tooltip library (which is mostly tipsy) then it can now be used on its own without requiring tipsy. The major advantage is that both a tip and a dialog can be displayed on an element.

Demo

TipSwift Demo

Usage

Include jquery and tipswift in the document head:

<script type="text/javascript" src="jquery.tipswift.js"></script>
<link rel="stylesheet" type="text/css" href="jquery.tipswift.css" />

Use a jQuery selector in your document ready function:

jQuery(function($) {
    $("#target").tipSwift({ 
      <options>,
      plugins: [...]
    });
});

Options

Tipswift options are listed in a javascript object (with their default values):

$.tipSwift.defaultCfg = {
  live: false,                             // wether to use live type of event binding
  gravity: 'n',                            // tip gravity
  offset: 0,                               // offset from the element edge in pixel
  opacity: 0.9,                            // opacity [0..1]
  showEffect: $.tipSwift.effects.show,     // effect used to show the tip
  hideEffect: $.tipSwift.effects.hide,     // effect used to hide the tip (must eventually remove() the tip)
  extraClass: [],                          // extra classes to add the tip
  html: false,                             // wether to use html for the tip content
  plugins: []                              // the list of plugins
};

Plugins

tip

Use this plugin to display tips

usage

$(<selector>).tipSwift({
  gravity: $.tipSwift.gravity.autoWE,
  live: true,
  plugins: [
    $.tipSwift.plugins.tip({
      offset: 5,
      gravity: 'e',
      opacity: 0.6,
      showEffect: $.tipSwift.effects.fadeIn,
      hideEffect: $.tipSwift.effects.fadeOut
    })
  ]
});

configuration

All tipSwift options can be overriden in the plugin configuration

pluginCfg: {
  showOn: ['mouseenter', 'focusin'],
  hideOn: ['mouseleave', 'focusout'],
  title: 'title',
  fallback: '',
  delayIn: 0,
  delayOut: 0,
  filterContent: $.noop
}

dialog

Use this plugin to display dialogs

usage

    $('#list-item a').tipSwift({
      gravity: $.tipSwift.gravity.autoWE,
      live: true,
      plugins: [
        $.tipSwift.plugins.dialog({
          showEffect: $.tipSwift.effects.slideOutWE,
          hideEffect: $.tipSwift.effects.slideInWE,
          opacity: 0.9,
          extraClass: ['delete'],
          title: 'Confirmation',
          body: 'Do you really want to delete this item ?',
          buttons: {
            yes: {
              label: 'Yes',
              action: function(e) {
                $(e.target).parents('li').fadeOut(function() { $(this).remove() });
              }
            },
            no: { label: 'no' }
          }
        })
      ]
    });

configuration

All tipSwift options can be overriden in the plugin configuration

pluginCfg: {
  showOn: ['click'],
  dialogTemplate: $.tipSwift.templates.dialog,        // the function used to build the dialog markup
  buttonTemplate: $.tipSwift.templates.dialogButton,  // the function used to build the buttons markup
  filterContent: $.noop
}

In order to display a dialog, you must define all the non optional properties:

  • title: HTML for the dialog title (or a function returning the title),
  • body (optional): HTML for the dialog body (or a function returning the title),
  • buttons: hash of buttons (or a function returning the hash), each key can have the following options:
    • label: button label,
    • action (optional): button onclick callback:
      • receive the event targeting the tipswift target as a parameter,
      • inside the function this is the tip jQuery object,
      • should return false to close the dialog,
      • when no action is specified, the default is to close the dialog.

Requirements

  • jQuery 1.4.2+

Authors & Contributors

History

v2.1.1

  • Fix for hiding the native tooltip on IE9

v2.1.0

  • API break: Modular architecture,
  • 2 built-in plugins: tip & dialogs

v2.0.1 - 2010-09-03

  • fix for IE

v2.0.0 - 2010-09-03

Major rewrite:

  • NEW: ability to display both a tip and a dialog for an element (each can define custom options),
  • NEW: dialog can have their content loaded through AJAX,
  • API break: tipswift() has been renammed to tipSwift(),
  • API break: the option format has changed.

v1.1.2 - 2010-08-19

  • Requires jQuery 1.4.2+

v1.1.1 - 2010-08-13

  • API BREAK: the target of events passed to button actions is no more a jQuery object
  • empty btnActions while closing opened instances

v1.1.0 - 2010-08-12

  • API BREAK: tipswift(options) now take a single hash as parameter, label has been moved to the hash and renamed title
  • refactoring
  • allow for dynamic titles

v1.0.1 - 2010-08-11

  • fix a bug when clicking on a trigger with an opened tipswift
  • improve show and hide animations

v1.0.0 - 2010-08-11

  • Initial release.

License

(The MIT License)

Copyright (c) 2010 Victor Berchet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.

Something went wrong with that request. Please try again.