summaryrefslogtreecommitdiffstats
path: root/jquery.once.js
blob: d946eb3766497dbf44a540be2a7bf19faa0d553a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
// Generated by CoffeeScript 1.8.0

/*
 * jQuery Once `2.0.0-alpha.10`
 * http://github.com/robloach/jquery-once
 *
 * Act on jQuery elements only once.
 *
 * - [MIT](http://www.opensource.org/licenses/mit-license.php)
 * - [GPL-2.0](http://www.gnu.org/licenses/gpl.html)
 */

/*
 * Universal Module Definition
 *
 * [jQuery](http://jquery.com) is a dependency, so we wrap the code with a
 * [UMD](https://github.com/umdjs/umd) pattern in order to allow loading jQuery,
 * and jQuery Once, using [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD),
 * [CommonJS](http://en.wikipedia.org/wiki/CommonJS), or as a global variable.
 */
(function(umd) {
  if (typeof exports === "object") {
    return umd(require("jquery"));
  }
  if (typeof define === "function" && define.amd) {
    return define(["jquery"], umd);
  }
  return umd(jQuery);
})(function($) {

  /*
   * Filter elements by whether they have not yet been processed.
   *
   * @param {string} id - The data id used to determine whether the given
   * elements have already been processed or not.
   *
   * @return jQuery element collection of elements that have now run once by the
   * given id.
   *
   * @example
   * // Change the color of the text to green.
   * $('p').once('changecolor').css('color', 'green');
   */
  $.fn.once = function(id) {
    var name;
    if (!id) {
      throw new Error("An ID is required when calling jQuery.once()");
    }
    name = "jquery-once-" + id;
    return this.filter(function() {
      return $(this).data(name) !== true;
    }).data(name, true);
  };

  /*
   * Removes the once data from the given elements, based on the given ID.
   *
   * @param {string} id - A required string representing the name of the data id
   * which should be used when filtering the elements. This only filters elements
   * that have already been processed by the once function. The id should be the
   * same id that was originally passed to the `.once()` function.
   *
   * @return jQuery element collection that had their `once` data removed.
   * @example
   * // Remove the once
   * $('p').removeOnce('changecolor').each(function() {
   *   // This function is run for each element that had its once data removed.
   * });
   */
  $.fn.removeOnce = function(id) {
    return this.findOnce(id).removeData("jquery-once-" + id);
  };

  /*
   * Filters elements that have already been processed once.
   *
   * @param {string} id - A required string representing the name of the data id
   * which should be used when filtering the elements. This only filters elements
   * that have already been processed by the once function. The id should be the
   * same id that was originally passed to the `.once()` function.
   *
   * @return jQuery element collection of elements that have been run once.
   *
   * @example
   * // Remove the once
   * $('p').findOnce('changecolor').each(function() {
   *   // This function is run for each element that has already been run once.
   * });
   */
  return $.fn.findOnce = function(id) {
    var name;
    name = "jquery-once-" + id;
    return this.filter(function() {
      return $(this).data(name) === true;
    });
  };
});

//# sourceMappingURL=jquery.once.js.map