Плагін на jQuery
У статті розглянуто основні правила, якими повинен керуватися веб-розробник під час написання плагіна на jQuery.
Файл, в якому розміщуватиметься плагін, бажано назвати, використовуючи наступний шаблонjquery.[ім'я_плагіна].js ;
До документа плагін підключається так:
Фундамент плагіна
Важливо, код плагіна необхідно поміщати в замикання, що саме викликається(function($)<>)(jQuery); щоб виключити конфлікти з іншими бібліотеками, які можуть використовувати знак долара($).
Нові плагіни приєднуються до об'єктаjQuery.fn object.
Зарезервоване слово this
При використанні зарезервованого слова це потрібно пам'ятати про два нюанси
Зручність jQuery полягає в можливості застосовувати до елементів документа ланцюжки методів, що послідовно викликаються. Тому в більшості випадків плагін конструюється таким чином, щоб змінити елемент або групу елементів і передати їх на обробку наступним методам. Якщо ви конструюєте плагін за таким принципом, то обов'язково повертайте цю головну функцію.
Ітерація об'єктів
Під час написання плагіна завжди використовуйте методthis.each() для ітерації всіх об'єктів. На прикладі вказаному нижче, дуже добре видно, що плагін застосовується до елемента div, а точніше до набору div документів. Використання this.each дозволяє грамотно обробити весь набір вказаних елементів div.
Опції плагіна
Складний плагін має набір параметрів. Рекомендується створити параметри за замовчуванням, які можна змінити або доповнити (використовуючи$.extend ) під час виклику плагіна.
У наступному прикладі плагін викликається з параметром "location": "left". В результаті налаштування за замовчуванням будутьзмінено, і параметр "location" змінить своє значення з "top" на "left".
Якщо плагін викликати без параметрів, всі налаштування залишаться за замовчуванням.
Ніколи не поміщайте більше одного імені в об'єкт jQuery.fn.
Найкраще зібрати всі ваші методи в один об'єкт і помістити його в замикання. При виклику плагіна перший параметр відповідатиме за назву методу, а інші параметри інші дії.
Виклик плагіна з різними параметрами:
Приклад плагіна
Як приклад, можете ознайомитися з плагіном для голосування.