public/assets/jquery-modern-blink-0-1-3/README.md

   1 # Modern Blink
   2
   3 jQuery plugin utilizing CSS Animations. Because we all loved the &lt;blink&gt; tag!
   4
   5 Modern Blink will use CSS Animations in browsers supporting them and fallback to jQuery Animations in older browsers.
   6
   7 **Demo**: http://codepen.io/leonderijke/pen/bkgxi
   8
   9 ## Installation
  10
  11 Include Modern Blink after the jQuery library:
  12
  13 ```html
  14 <script src="/path/to/jquery.modern-blink.js"></script>
  15 ```
  16
  17 Or, install via Bower:
  18
  19 ```
  20 bower install modern-blink
  21 ```
  22
  23 ## Usage
  24
  25 Use Modern Blink like this on the desired elements:
  26
  27 ```js
  28 $('.js-blink').modernBlink();
  29 ```
  30
  31 ### Options
  32
  33 The following options can be passed to Modern Blink (defaults are shown):
  34
  35 ```js
  36 $(element).modernBlink({
  37         // Duration specified in milliseconds (integer)
  38         duration: 1000,
  39
  40         // Number of times the element should blink ("infinite" or integer)
  41         iterationCount: "infinite",
  42
  43         // Whether to start automatically or not (boolean)
  44         auto: true
  45 });
  46 ```
  47
  48 ### Methods
  49
  50 Modern Blink provides the following public methods:
  51
  52 ```js
  53 $(element).modernBlink('start'); // Will start the animation
  54 $(element).modernBlink('stop'); // Will stop the animation
  55 ```
  56
  57 ### Events
  58
  59 Modern Blink will attach the following event listeners to the element:
  60
  61 ```js
  62 $(element).trigger('modernBlink.start'); // Will start the animation
  63 $(element).trigger('modernBlink.stop'); // Will stop the animation
  64 ```
  65
  66 ## Browser Support
  67
  68 Tested in:
  69 * Chrome
  70 * Safari
  71 * Firefox
  72 * Mobile Safari 5.1+
  73 * Android browser 4.0+
  74 * Internet Explorer 6+
  75
  76 ## License
  77
  78 MIT License