Ein jQuery Plugin schreiben - jquery.stance
jQuery ist eine coole Bibliothek um DOM Manipulationen zu machen, dabei abstrahiert jQuery auch noch die Browserspezifischen Eigenheiten. Um zum Beispiel den Inhalt eines div Elements mit der Id "dasDiv" zu ändern schreibt man in jQuery einfach
$("#dasDiv").html("Neuer Inhalt");
Das schöne an jQuery ist das Erweiterungskonzept mittels Plugins. Man kann sich sehr einfach in die bestehende Bibliothek einklinken und wird entsprechend aufgerufen.
Das Plugin Grundgerüst
Der Einstieg ist einfach. Ein Plugin ist eine Funktion die man für jQuery registriert. Die Registrierung erfolgt über fn und sieht z.B. so aus
$.fn.stance = function() { ... }
Das ist ein einfaches Konzept. Fehlt nur noch das drumherum. Plugins leben in der Regel in eigenen Dateien. Man benötigt dementsprechend Kontext um mit jQuery arbeiten zu können. In Javascript gibt es das allseits beliebte Konstrukt
(function(){})()
Damit führt man Code in einer anonymen Funktion aus. Was ist der Vorteil gegenüber einfachen inline Skript? Nun, man kann auch Parameter übergeben. Und genau das brauchen wir für das Plugin.
(function($) {
$.fn.stance = function() {
$(this).html("Hallo aus dem Plugin");
}
})(jQuery);
Dies ist ein erstes funktionales Plugin. Wir können es sogleich benutzen
<script src="jquery.stance.js"></script>
<script>
$(function() {
$("#output").stance();
});
</script>
...
<div id="output">Ersetz mich</div>
und sehen das der Text Ersetz mich durch Hallo aus dem Plugin ausgetauscht wird.
Mehrere Elemente unterstützen
Allerdings funktioniert das Plugin genau bei einem einzigen Element. Um mehrere Elemente zu unterstützen, z.B. die Selektion aller div Elemente, gibt man lediglich eine Funktion für jedes selektierte Element zurück.
$.fn.stance = function() {
return this.each(function() {
...
});
}
Voilá!
Optionen
Die meisten Plugins lassen sich parametriesieren und so im Ausführungsverhalten ändern. Das wird meist über ein Objekt realisiert das die Parameter dem Plugin übergibt. Es gibt hierbei auch Pflichtparameter. Gute Plugins geben Standard-Werte für Pflichtparameter innerhalb des Plugins an und vereinen das einkommende Objekt mit diesen. Das würde im Code zum Beispiel folgendermaßen aussehen:
$.fn.stance = function( text, options ) {
var settings = {
fontFamily : "Arial Black",
fontSize : 96,
shadow : true,
resize : true
};
if( options ) {
$.extend( settings, options );
}
...
}
$.extend sorgt dafür das die Optionen in die Settings vereint werden.
jquery.stance.js
Um das ganze auch mal in einem größeren Kontext zu zeigen habe ich ein Beispiel Plugin geschrieben. Das Plugin stanzt dabei eine Grafik mit dem Text der übergeben wird aus. Hierzu wird ein HTML5 Canvas benutzt. Das ursprüngliche Bild wird reingeladen, der Text wird zentriert draufgezeichnet unter Benutzung einer Komposition und ein wenig Schatten garniert das ganze noch. Das Projekt jquery.stance.js liegt auf Github. Es enthält eine Demo die veranschaulicht wie das Plugin funktioniert. Die Anwendung ist recht einfach.
<img id="wood" src="lighter_wood.jpg"/>
$("#wood").stance("HTML5!");
Das Ergebnis ist diese Grafik:

Fazit
jQuery um eigene Plugins zu erweitern ist technisch gesehen recht einfach. Das größte Problem war letztlich das Design des Plugins, wie es funktionieren soll und welche Parameter es erwartet. Ich denke für einen ersten Versuch ist es schon recht gut gelungen, ich bin mir aber sicher das auch hier viel Verbesserungspotential steckt. Falls Ihr Plugins geschrieben habt, pingt mich an, ich würde mir mal diese gerne anschauen.