-
Notifications
You must be signed in to change notification settings - Fork 26
/
plugin-boilerplate.sublime-snippet
73 lines (56 loc) · 2.25 KB
/
plugin-boilerplate.sublime-snippet
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
<snippet>
<content><![CDATA[
/*
* Project: $1
* Description: $2
* Author: $3
* License: $4
*/
// the semi-colon before function invocation is a safety net against concatenated
// scripts and/or other plugins which may not be closed properly.
;(function ( \$, window, undefined ) {
// undefined is used here as the undefined global variable in ECMAScript 3 is
// mutable (ie. it can be changed by someone else). undefined isn't really being
// passed in so we can ensure the value of it is truly undefined. In ES5, undefined
// can no longer be modified.
// window and document are passed through as local variables rather than globals
// as this (slightly) quickens the resolution process and can be more efficiently
// minified (especially when both are regularly referenced in your plugin).
// Create the defaults once
var pluginName = '${5:defaultPluginName}',
document = window.document,
defaults = {
propertyName: "value"
};
// The actual plugin constructor
function Plugin( element, options ) {
this.element = element;
// jQuery has an extend method which merges the contents of two or
// more objects, storing the result in the first object. The first object
// is generally empty as we don't want to alter the default options for
// future instances of the plugin
this.options = \$.extend( {}, defaults, options) ;
this._defaults = defaults;
this._name = pluginName;
this.init();
}
Plugin.prototype.init = function () {
// Place initialization logic here
// You already have access to the DOM element and the options via the instance,
// e.g., this.element and this.options
$6
};
// A really lightweight plugin wrapper around the constructor,
// preventing against multiple instantiations
\$.fn[pluginName] = function ( options ) {
return this.each(function () {
if (!\$.data(this, 'plugin_' + pluginName)) {
\$.data(this, 'plugin_' + pluginName, new Plugin( this, options ));
}
});
}
}(jQuery, window));]]></content>
<tabTrigger>jq-boilerplate</tabTrigger>
<scope>source.js</scope>
<description>jQuery Plugin Boilerplate</description>
</snippet>