jQuery UI API - Puente de complementos (Widget Plugin Bridge)
Categoría
Utilidades (Utilities) | Widgets
Uso
Descripción:El método jQuery.widget.bridge() esparte de la Fábrica de Widgets de jQuery (Widget Factory).Actúa como intermediario entre los objetos creados por $.widget() y la API de jQuery.
| Parámetros | Tipo | Tipo |
|---|---|---|
| name | String | El nombre del complemento que se va a crear. |
| constructor | Function() | El objeto que se instanciará cuando se llame al complemento. |
$.widget.bridge()Hace lo siguiente:
- Conecta un constructor de JavaScript normal a la API de jQuery.
- Crea automáticamente instancias de objetos y las almacena en la
$.datacaché del elemento. - Permite llamar a métodos públicos.
- Evita llamar a métodos privados.
- Evita llamar a métodos en objetos no inicializados.
- Evita múltiples inicializaciones.
Los widgets de jQuery UI utilizan$.widget( "foo.bar", {} );una sintaxis para definir un objeto para crear. Dada una estructura DOM con cinco.foo,$( ".foo" ).bar();elementos, se crearán cinco instancias del objeto 'bar'.$.widget.bridge()Basándose en el objeto 'bar' y una API pública, funciona dentro de la biblioteca. Por lo tanto, puede escribir$( ".foo" ).bar()para crear una instancia, y escribir$( ".foo" ).bar( "baz" )para llamar a métodos.
Si solo desea inicializar y llamar a métodos una vez, entonces el objeto que pasajQuery.widget.bridge()puede ser muy pequeño:
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 );
}
};
Aquí solo necesita un constructor que recibe dos parámetros:
options: un objeto de opciones de configuraciónelement: el elemento DOM en el que se crea la instancia.
Luego puede utilizar el puente (bridge) para convertir ese objeto en un complemento de jQuery y utilizarlo en cualquier objeto de 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" );
});
Para usar todas las características del puente (bridge), el prototipo de su objeto debe tener un_init()método. Este método se llama cuando se invoca el complemento y la instancia ya existe. En este caso, también debe tener unoption()método. Este método se llamará con las opciones como primer parámetro. Si no hay opciones, el parámetro es un objeto vacío. Para conocer el uso deloptionmétodo, consulte$.Widget。
El puente (bridge) tiene una propiedad opcional, si existe: si el prototipo del objeto tiene unawidgetFullNamepropiedad, se usará esa propiedad como clave para almacenar y recuperar la instancia. De lo contrario, se utilizará el parámetro name.