jQuery UI Comment cela fonctionne
jQuery UI contient de nombreux widgets avec état (Widget), ce qui le rend légèrement différent du modèle d'utilisation typique des plugins jQuery. Son installation est similaire à celle de la plupart des plugins jQuery. Les widgets jQuery UI sont basés surWidget Factorycréée, la Widget Factory fournit une API commune. Ainsi, une fois que vous avez appris à en utiliser un, vous savez utiliser les autres widgets. Ce tutoriel utilisera des exemples de code du widgetprogressbarpour présenter les fonctionnalités communes.
Installation
Afin de suivre l'état du widget, nous présentons d'abord le cycle de vie complet d'un widget. Le cycle de vie commence lorsque le widget est installé. Nous avons seulement besoin d'appeler le plugin sur un ou plusieurs éléments pour installer le widget.
$( "#elem" ).progressbar();
Cela initialisera chaque élément dans l'objet jQuery. Dans cet exemple, l'id de l'élément est "elem". Parce que nous appelons la.progressbar()méthode sans argument, le widget sera initialisé selon ses options par défaut. Nous pouvons passer un ensemble d'options lors de l'installation pour remplacer les options par défaut.
$( "#elem" ).progressbar({ value: 20 });
Le nombre d'options passées lors de l'installation peut être déterminé par nos besoins. Toutes les options que nous ne passons pas utiliseront leurs valeurs par défaut.
Les options font partie de l'état du widget, donc nous pouvons également définir des options après l'installation. Nous présenterons cela dans laoptionsection Méthodes.
Méthodes
Maintenant que le widget est initialisé, nous pouvons interroger son état ou effectuer des actions sur celui-ci. Toutes les actions après initialisation se présentent sous forme d'appels de méthode. Pour appeler une méthode sur un widget, nous pouvons passer le nom de la méthode au plugin jQuery. Par exemple, pour appeler lavalueméthode du widget progressbar, nous devons utiliser :
$( "#elem" ).progressbar( "value" );
Si la méthode accepte des paramètres, nous pouvons passer des paramètres après le nom de la méthode. Par exemple, pour passer des paramètres pour la40Donnervalueméthode, nous pouvons utiliser :
$( "#elem" ).progressbar( "value", 40 );
Comme les autres méthodes de jQuery, la plupart des méthodes de widget renvoient des objets jQuery pour le chaînage.
$( "#elem" )
.progressbar( "value", 90 )
.addClass( "almost-done" );
Méthodes publiques
Chaque widget possède son propre ensemble de méthodes en fonction des fonctionnalités qu'il fournit. Cependant, certaines méthodes sont communes à tous les widgets.
option
Comme nous l'avons mentionné précédemment, nous pouvons modifier les options après l'initialisation via laoptionméthode. Par exemple, nous pouvons appeler laoptionméthode pour changer la valeur de progressbar à 30.
$( "#elem" ).progressbar( "option", "value", 30 );
Notez que ceci est différent de l'instance précédente où nous avons appelé lavalueméthode. Dans ce cas, nous appelons laoptionméthode, en changeant l'option value à 30.
Nous pouvons également obtenir la valeur actuelle d'une option.
$( "#elem" ).progressbar( "option", "value" );
De plus, nous pouvons passer à laoptionméthode un objet pour mettre à jour plusieurs options à la fois.
$( "#elem" ).progressbar( "option", {
value: 100,
disabled: true
});
Vous avez peut-être remarqué que laoptionméthode a la même signature que le getter et le setter dans le code jQuery, tout comme.css()et.attr(). La seule différence est que vous devez passer la chaîne "option" comme premier paramètre.
disable
disableLa méthode désactive le widget. Dans l'instance progressbar, cela change le style pour afficher la barre de progression comme désactivée.
$( "#elem" ).progressbar( "disable" );
Appel de ladisableLa méthode est équivalente à définir ledisabledoption àtrue。
enable
enableLa méthode estdisableL'opposé de la méthode.
$( "#elem" ).progressbar( "enable" );
Appel de laenableLa méthode est équivalente à définir ledisabledoption àfalse。
destroy
Si vous n'avez plus besoin du widget, vous pouvez le détruire et revenir au balisage d'origine. Cela signifie la fin du cycle de vie du widget.
$( "#elem" ).progressbar( "destroy" );
Une fois que vous détruisez un widget, vous ne pouvez appeler aucune méthode dessus à moins de réinitialiser ce widget. Si vous souhaitez supprimer l'élément, vous pouvez directement utiliser.remove(), ou vous pouvez utiliser.html()ou.empty()pour ce faire, et le widget sera détruit automatiquement.
widget
Certains widgets génèrent des éléments conteneurs, ou des éléments qui sont déconnectés de l'élément d'origine. Dans l'exemple ci-dessous,widgetrenverra l'élément généré. Dans l'instance progressbar, il n'y a pas de conteneur généré,widgetLa méthode retourne l'élément d'origine.
$( "#elem" ).progressbar( "widget" );
Événements
Tous les widgets ont des événements liés à leurs différents comportements, utilisés pour vous notifier lorsque l'état change. Pour la plupart des widgets, lorsqu'un événement est déclenché, le nom est préfixé par le nom du widget. Par exemple, nous pouvons lier l'événement change du progressbar, qui est déclenché chaque fois que la valeur change.
$( "#elem" ).bind( "progressbarchange", function() {
alert( "The value has changed!" );
});
Chaque événement a un callback correspondant, présenté comme une option. Nous pouvons utiliser lechangecallback du progressbar, ce qui équivaut à lier leprogressbarchangeévénement.
$( "#elem" ).progressbar({
change: function() {
alert( "The value has changed!" );
}
});
Événements publics
La plupart des événements sont spécifiques à des widgets particuliers ; tous les widgets ont uncreateévénement commun. Cet événement est déclenché lorsque le widget est créé.