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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*!
* jQuery Once v2.0.0-beta.2 - http://github.com/robloach/jquery-once
* @license MIT, GPL-2.0
* http://opensource.org/licenses/MIT
* http://opensource.org/licenses/GPL-2.0
*/
/**
* Universal Module Definition
*
* jQuery is a dependency, so we wrap the code with a UMD pattern in order to
* allow loading jQuery and jQuery Once through a module definition like
* CommonJS, AMD, or otherwise.
*
* @see {@link http://github.com/umdjs/umd}
*/
(function (factory) {
"use strict";
if (typeof exports === "object") {
// CommonJS
factory(require("jquery"));
} else if (typeof define === "function" && define.amd) {
// AMD
define(["jquery"], factory);
} else {
// Global object
factory(jQuery);
}
}(function ($) {
"use strict";
/**
* Ensures that the given ID is valid, returning "once" if one is not given.
*
* @param {string} [id="once"]
* A string representing the ID to check. Defaults to `"once"`.
*
* @returns The valid ID name.
*
* @throws Error when an ID is provided, but not a string.
* @private
*/
var checkId = function(id) {
id = id || "once";
if (typeof id !== "string") {
throw new Error("The jQuery Once id parameter must be a string");
}
return id;
};
/**
* Filter elements by whether they have not yet been processed.
*
* @param {string} [id="once"]
* The data ID used to determine whether the given elements have already
* been processed or not. Defaults to `"once"`.
*
* @returns jQuery collection of elements that have now run once by
* the given ID.
*
* @example
* ``` javascript
* // The following will change the color of each paragraph to red, just once
* // for the "changecolor" key.
* $('p').once('changecolor').css('color', 'red');
*
* // .once() will return a set of elements that yet to have the once ID
* // associated with them. You can return to the original collection set by
* // using .end().
* $('p')
* .once("changecolorblue")
* .css("color", "blue")
* .end()
* .css("color", "red");
*
* // To execute a function on the once set, you can use jQuery's each().
* $('div.calendar').once().each(function() {
* // Since there is no once ID provided here, the key will be "once".
* });
* ```
*
* @see removeOnce
* @see findOnce
* @this jQuery
*
* @global
* @public
*/
$.fn.once = function (id) {
// Build the name for the data identifier. Generate a new unique ID if the
// ID parameter is not provided.
var name = "jquery-once-" + checkId(id);
// Filter the elements by whi*ch do not have the data yet.
return this.filter(function() {
return $(this).data(name) !== true;
}).data(name, true);
};
/**
* Removes the once data from elements, based on the given ID.
*
* @param {string} [id="once"]
* A 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. Defaults to `"once"`.
*
* @returns jQuery collection of elements that were acted upon to remove their
* once data.
*
* @example
* ``` javascript
* // Remove once data with the "changecolor" ID. The result set is the
* // elements that had their once data removed.
* $('p').removeOnce("changecolor").css("color", "");
*
* // Any jQuery function can be performed on the result set.
* $("div.calendar").removeOnce().each(function() {
* // Remove the calendar behavior.
* });
* ```
*
* @see once
* @this jQuery
*
* @global
* @public
*/
$.fn.removeOnce = function (id) {
// Filter through the elements to find the once'd elements.
return this.findOnce(id).removeData("jquery-once-" + checkId(id));
};
/**
* Filters elements that have already been processed once.
*
* @param {string} [id="once"]
* A 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. Defaults to "once".
*
* @returns jQuery collection of elements that have been run once.
*
* @example
* ``` javascript
* // Find all elements that have been changecolor'ed once.
* $('p').findOnce('changecolor').each(function() {
* // This function is called for all elements that has already once'd.
* });
*
* // Find all elements that have been acted on with the default "once" key.
* $('p').findOnce().each(function() {
* // This function is called for all elements that have been acted on with
* // a "once" action.
* });
* ```
*
* @see once
* @this jQuery
*
* @global
* @public
*/
$.fn.findOnce = function (id) {
// Filter the elements by which do have the data.
var name = "jquery-once-" + checkId(id);
return this.filter(function() {
return $(this).data(name) === true;
});
};
}));
|
