Пишем свой плагин подсказок

Написание плагинов для jQuery та задача, которая рано или поздно становится перед  любым веб-программистом. Потому что сколько бы плагинов не существовало в природе, но все равно они полностью могут не удовлетворять ни программиста ни заказчика сайта. Именно поэтому необходимо знать, как пишутся эти плагины и зачем их писать.

Чаще всего прелесть плагинов в том, что их можно многократно вызывать и не надо для этого писать массу кода каждый раз, достаточно передать лишь заложенные в плагин переменные.

В данном уроке мы напишем простой плагин вывода подсказок:

Для начала немного правил, которых следует придерживаться при написании собственного плагина:

  1. Имя файла плагина должно быть следующее – jquery.[имя плагина].js;
  2. Все новые методы необходимо присоединять к объекту jQuery.fn, а все функции к объекту jQuery;
  3. В любом методе, this – это обращение к текущему объекту jQuery;
  4. В конце любой функции или метода необходимо ставить точку с запятой, чтобы избежать неккоректности кода при сжатии;
  5. Метод должен возвратить объект jQuery, если не предусмотрено другое;
  6. Всегда используйте jQuery вместо $ в коде плагина, что позволит пользователям изменять псевдоним для jQuery в единственном месте.

Итак, теперь следуя всем выше перечисленным правилам, приступаем к созданию нашего плагина.

Сразу покажу пример подключения подсказки, чтобы уже больше на этом не останавливаться:

А так же стиль подсказки:

.tip {
    color: #fff;
    background:#1d1d1d;
    display:none; /*--Hides by default--*/
    padding:10px;
    position:absolute;
	z-index:1000;
    -webkit-border-radius: 3px;
    -moz-border-radius: 3px;
    border-radius: 3px;
}

Для начала создадим файл плагина с именем jquery.jTooltip.js и поместив его в папку с jquery.js (у меня это всегда папка scripts) приступим к его редактированию. Первое что нам надо это создать новый объект jQuery:

 jQuery.fn.jTooltip = function(options) {
 }

Теперь мы должны определить опции, которые будут доступны пользователю для изменения:

	var options = jQuery.extend({
		type		: "fixed", 		// допустимые значения fixed, mousemove
		showSpeed	: 0,			// скорость проявления подсказки
		hideSpeed	: 0, 			// скорость исчезания подсказки
		classTip	: ".tip"		// определяется класс, который будет хранить подсказку
		}, options);

Как видите, мы определили, что у нас может быть два способа отображения подсказок, фиксированное и плавающее за мышью. Так же мы определили два параметра скорости, с которой подсказка может появляться и исчезать, а так же класс, который будет определять местоположение подсказки в HTML коде. Стоит так же объяснить почему мы используем функцию extend и после описания всех переменных добавляем еще раз options. Все дело в том, что функция extend позволит скрипту объединить полученные от пользователя значения и значения по умолчанию, т.е. если например, были описаны пользовательские переменные но не все, то он их использует, а те что были пользователем пропущены он применит значения по умолчанию. А дополнительный параметр options позволит пользователю использовать свои параметры.

Теперь напишем самую простую часть кода, это наведение мыши на ссылку с подсказкой:

		jQuery(this).hover(function() {
						tip = jQuery(this).find(options.classTip); //Находим все определенные нами подсказки и заносим их в переменную
						tip.show(options.showSpeed); //Показываем подсказку при наведении
					},  
				   function() {
						tip.hide(options.hideSpeed); //Прячем подсказку при потери элементом наведения
					});

Тут все просто, но как вы помните, у нас еще и было задумано создать плавающую за мышью подсказку. Тут нам придется создать небольшое условие:

		if (options.type == "mousemove") { }

Где мы объекту jQuery(this) укажем исполнение функции mousemove и определим все переменные в области этой функции:

			jQuery(this).mousemove(function(e) {
				var mouseX = e.pageX + 20, //Получаем координаты по оси Х
					mouseY = e.pageY + 20, //Получаем координаты по оси Y
					tipWidth = tip.width(), //Получаем ширину подсказки
					tipHeight = tip.height(), //Получаем высоту подсказки
					tipVisX = jQuery(window).width() - (mouseX + tipWidth), //Дистанция от правого края ссылки на подсказку
					tipVisY = jQuery(window).height() - (mouseY + tipHeight); //Дистанция от нижнего края ссылки на подсказку

Как видите, мы определяем положение подсказки относительно краев экрана так, чтобы она всегда была в зоне видимости. Далее нам необходимо динамически передать подсказке ее текущее положение на экране относительно указателя мыши:

				//Определяем положение на экране
				if (tipVisX < 20) {
					mouseX = e.pageX - tipWidth - 20;
				}
				if (tipVisY < 20) {
					mouseY = e.pageY - tipHeight - 20;
				}

И осталось теперь все полученные данные передать нашей подсказке в качестве атрибутов CSS:

				//Абсолютное позиционирование подсказки в этой области нам поможет
				//мы можем динамически передавать атрибутам блока отступ с верху и с лева,
				//а так же желательно передать ширину полученной подсказки, чтобы не было проблем с отображением
				tip.css({ top : mouseY, left : mouseX, width : tipWidth});

Теперь мы можем вызывать данный плагин сколь угодно раз, например для создания нескольких видов подсказок, ведь вы помните мы определили пользовательский класс для подсказок classTip. Вызов плагина происходит следующим образом:

$(document).ready(function(){
   $(".tooltip").jTooltip({
		type : "mousemove"
	});
});

Вот собственно и все.

Источник: http://feedproxy.google.com/~r/ruseller/CdHX/~3/FseMAL9Y1ys/lessons.php

Читать комменты и комментировать

Добавить комментарий / отзыв



Защитный код
Обновить

Пишем свой плагин подсказок | | 2012-06-25 16:21:30 | | Статьи Web-мастеру | | Написание плагинов для jQuery та задача, которая рано или поздно становится перед  любым веб-программистом. Потому что сколько бы плагинов не существовало в природе, но все равно они полностью могут | РэдЛайн, создание сайта, заказать сайт, разработка сайтов, реклама в Интернете, продвижение, маркетинговые исследования, дизайн студия, веб дизайн, раскрутка сайта, создать сайт компании, сделать сайт, создание сайтов, изготовление сайта, обслуживание сайтов, изготовление сайтов, заказать интернет сайт, создать сайт, изготовить сайт, разработка сайта, web студия, создание веб сайта, поддержка сайта, сайт на заказ, сопровождение сайта, дизайн сайта, сайт под ключ, заказ сайта, реклама сайта, хостинг, регистрация доменов, хабаровск, краснодар, москва, комсомольск |
 
Поделиться с друзьями: