plugin jQuery avec sa propre API

Question

Je suis en train d'écrire mon premier plugin jQuery et je veux être en mesure de le faire:

var myPluginVar = $("someElement").myPlugin(); 

myPluginVar.customFunctionCallWithinPlugin(); 

Toute idée de comment s'y prendre?

EDIT

S'il vous plaît visitez http://flowplayer.org/tools/using.html#api pour voir ce que je veux dire

Answer 1

Vous pouvez réaliser cette conception avec quelque chose de semblable à ce qui suit. J'ai enveloppé la définition de plugin dans une fonction anonyme pour empêcher PluginObj de polluer l'espace de noms global.

(function($) { 
    function PluginObj() { 
     // construct stuff 
    } 

    PluginObj.prototype.customFunctionCallWithinPlugin = function() { 
     // do stuff 
    }; 

    $.fn.myPlugin = function() { 
     return new PluginObj(); 
    }; 
})(jQuery); 

La méthode jQuery renvoie un nouvel objet avec les méthodes que vous définissez. Ceci est un design non-standard pour un plugin jQuery, donc si vous envisagez de le distribuer assurez-vous qu'il est bien documenté.

Answer 2

Vous devrez peut-être retourner une instance du plug-in plutôt que « ce ».

par exemple.

(function(){ 
    // private constructor that is only accessable by your plugin. 
    function _Plugin(elements, args){ 
     // do stuff 
    } 
    _Plugin.prototype.customFunctionCallWithinPlugin = function(){ 
     // do more stuff 
    }; 
    $.fn.Plugin = function(args){ 
     return new _Plugin(this, args); 
    }; 
})(); 

EDIT: Alex m'a battu.