jQuery UI API - Pont de plugin de widget

Catégorie

Utilitaires | Widgets

Utilisation

Description :La méthode jQuery.widget.bridge() faitpartie de la jQuery Widget Factory.Elle sert d'intermédiaire entre les objets créés par $.widget() et l'API jQuery.

jQuery.widget.bridge( name, constructor )

Parameters Type Type
name String Le nom du plugin à créer.
constructor Function() L'objet à instancier lorsque le plugin est appelé.

$.widget.bridge()Effectue ce qui suit :

  • Connecte un constructeur JavaScript ordinaire à l'API jQuery.
  • Crée automatiquement des instances d'objet et les stocke dans le$.datacache de l'élément.
  • Permet d'appeler des méthodes publiques.
  • Empêche d'appeler des méthodes privées.
  • Empêche l'appel de méthodes sur des objets non initialisés.
  • Empêche les initialisations multiples.

Les widgets jQuery UI utilisent$.widget( "foo.bar", {} );la syntaxe pour définir un objet à créer. Étant donné une structure DOM avec cinq.foo,$( ".foo" ).bar();structures DOM créeront cinq instances de l'objet "bar".$.widget.bridge()Sur la base de l'objet "bar" et d'une API publique, cela fonctionne au sein de la bibliothèque. Par conséquent, vous pouvez écrire$( ".foo" ).bar()pour créer des instances, et écrire$( ".foo" ).bar( "baz" )pour appeler des méthodes.

Si vous souhaitez seulement initialiser une fois et appeler des méthodes, alors l'objet que vous passez àjQuery.widget.bridge()peut être très petit :

var Highlighter = function( options, element ) {
  this.options = options;
  this.element = $( element );
  this._set( 800 );
};
Highlighter.prototype = {
  toggle: function() {
    this._set( this.element.css( "font-weight") === 400 ? 800 : 400 );
  },
  _set: function(value) {
    this.element.css( "font-weight", value );
  }
};

Ici, tout ce dont vous avez besoin est un constructeur qui prend deux paramètres :

  • options: un objet d'options de configuration
  • element: l’élément DOM sur lequel l’instance est créée

Ensuite, vous pouvez utiliser le pont pour utiliser l’objet comme plugin jQuery, et vous pouvez l’utiliser sur n’importe quel objet jQuery :

// Hook up the plugin
$.widget.bridge( "colorToggle", Highlighter );
 
// Initialize it on divs
$( "div" ).colorToggle().click(function() {
  // Call the public method on click
  $( this ).colorToggle( "toggle" );
});

Pour utiliser toutes les fonctionnalités du pont, le prototype de votre objet a besoin d’une_init()méthode. Cette méthode est appelée lorsque le plugin est invoqué et qu’une instance existe déjà. Dans ce cas, vous avez aussi besoin d’uneoption()méthode. Cette méthode sera appelée avec les options comme premier argument. S’il n’y a pas d’options, l’argument est un objet vide. Pour en savoir plus suroptionl’utilisation de la méthode, voir$.Widget。

Le pont a une propriété optionnelle, si présente : si le prototype de l’objet a unewidgetFullNamepropriété, cette propriété sera utilisée comme clé pour stocker et récupérer les instances. Sinon, le paramètre name sera utilisé.

Autres extensions