jQuery UI API - Мост плагина виджета

Категория

Утилиты | Виджеты

Использование

Описание:Метод jQuery.widget.bridge() являетсячастью jQuery Widget Factory.Он действует как посредник между объектами, созданными $.widget(), и jQuery API.

jQuery.widget.bridge( name, constructor )

Parameters Type Type
name String Имя создаваемого плагина.
constructor Function() Объект, экземпляр которого создается при вызове плагина.

$.widget.bridge()Делает следующее:

  • Связывает обычный конструктор JavaScript с jQuery API.
  • Автоматически создает экземпляры объектов и сохраняет их в$.dataкэше элемента.
  • Позволяет вызывать публичные методы.
  • Запрещает вызывать приватные методы.
  • Предотвращает вызов методов на неинициализированных объектах.
  • Предотвращает многократные инициализации.

Виджеты jQuery UI используют$.widget( "foo.bar", {} );синтаксис для определения создаваемого объекта. Если дана DOM-структура с пятью.foo,$( ".foo" ).bar();DOM-структурами, будет создано пять экземпляров объекта "bar".$.widget.bridge()Основываясь на объекте "bar" и публичном API, он работает внутри библиотеки. Поэтому вы можете написать$( ".foo" ).bar()чтобы создавать экземпляры, и написать$( ".foo" ).bar( "baz" )чтобы вызывать методы.

Если вы хотите инициализировать только один раз и вызывать методы, то объект, который вы передаёте вjQuery.widget.bridge()может быть очень маленьким:

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 );
  }
};

Здесь всё, что вам нужно, — это конструктор, принимающий два параметра:

  • options: объект параметров конфигурации
  • element: DOM-элемент, на котором создается экземпляр

Затем вы можете использовать bridge, чтобы применять объект как плагин jQuery, и вызывать его на любом объекте 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" );
});

Чтобы использовать все возможности bridge, прототипу вашего объекта нужен_init()метод. Этот метод вызывается, когда плагин вызывается, а экземпляр уже существует. В этом случае вам также нуженoption()метод. Этот метод будет вызван с options в качестве первого аргумента. Если options нет, аргумент — пустой объект. Чтобы узнать оoptionиспользовании метода, см.$.Widget。

У bridge есть необязательное свойство, если оно присутствует: если у прототипа объекта естьwidgetFullNameсвойство, это свойство будет использоваться как ключ для хранения и извлечения экземпляров. В противном случае будет использоваться параметр name.

Другие расширения