Миниатюрная система помощи на сайте

В данном уроке мы сделаем миниатюрную систему помощи на jQuery. Проект будет иметь вид небольшого виджета, который выводит текст помощи или руководство пользователя для вашего веб приложения. По содержанию виджета можно проводить поиск в реальном времени, а найденные фрагменты будут подсвечиваться.

 

Идея

Для реализации нашего примера будем действовать следующим образом:

  • Ловим событие input для поля ввода текста. Такой подход лучше чем, использование keypress, так как input реагирует на операции копирования/ вставки и отмены/повторения. Событие input не поддерживается в старых браузерах (<IE9). Поэтому вы можете заменить его на keypress, если потребуется действие примера везде, где можно.
  • Мы сделаем плагин jQuery, который будет называться “highlight”, который будет заменять найденный текст на элемент <span>;
  • Мы будем использовать плагин jQuery.scrollTo для плавной прокрутки элемента <span> в окно просмотра.

Начнем работу с разметки.

 

HTML

Сначала сделаем структуру страницы, с которой будем работать:

!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>Миниатюрная система помощи с использованием jQuery | Материалы сайта RUSELLER.COM</title>

        <!-- Стили -->
        <link rel="stylesheet" href="/assets/css/styles.css" />

    </head>
    <body>

		<div id="widget">

			<div id="header">
				<input type="text" id="search" placeholder="Поиск текста" />
			</div>

			<div id="content">
				<!-- Текст располагается здесь -->
			</div>
		</div>??

        <!-- JavaScript -->
        <script src="http://code.jquery.com/jquery-1.8.3.min.js"></script>
        <script src="/assets/js/highlight.jquery.js"></script>
        <script src="/assets/js/jquery.scrollTo.min.js"></script>
        <script src="/assets/js/script.js"></script>

    </body>
</html>

Здесь ничего оригинального нет - подключаем стили в заголовке (стили можно посмотреть в исходниках), jQuery и плагин scrollTo внизу страницы вместе с двумя другими файлами JavaScript, которые мы рассмотрим позже. Виджет имеет поле ввода текста (внутри элемента #header) и контейнер #content. Внутри контейнера вы можете помещать свой текст руководства для приложения.

 

jQuery

Теперь напишем плагин jQuery, который будет искать заданное слово в элементе #content и заменять найденные фрагменты элементами span. Например, поиск слова javascript в тексте javascript is awesome будет приводить к результату <span class="match">javascript</span> is awesome. Мы зададим стили для класса .match - оранжевый фон, чтобы выделить найденный фрагмент.

Плагин будет получать два аргумента  – фрагмент для поиска (как строку) и опциональную возвратную функцию, которая будет выполняться после завершения поиска/замены. Мы будем использовать возвратную функцию для привязки плагина scrollTo и прокрутки элемента #content до места расположения найденного фрагмента.

Прежде, чем разбирать код, обратите внимание, что вы не можете  просто извлекать внутренний код элемента div и вызвать replace() для замены найденного фрагмента элементом span, так как данное действие приведет к нарушению разметки. Если кто-то введет для поиска “div”, то все элементы <div> будут заменены на  <<span class="match">div</span>>, что приведет к проблемам.

Решение немного сложнее (но не настолько трудное, чтобы от него отказываться) – используем метод jQuery contents() для получения все наследников элемента и используем функцию replace() только для текста в текстовых узлах (таким образом гарантируется, что в тексте нет никакого кода HTML). Затем в цикле обрабатываем все элементы, не являющиеся текстовыми узлами в рекурсии и повторяем для них все действия.

(function($) {

	var termPattern;

	$.fn.highlight = function(term, callback) {

		return this.each(function() {

			var elem = $(this);

			if (!elem.data('highlight-original')) {
				
				// Сохраняем оригинальное содержание элемента
				elem.data('highlight-original', elem.html());
				
			} else {
				
				// Восстанавливаем оригинальное содержание 
				elem.highlightRestore();
				
			}

			termPattern = new RegExp('(' + term + ')', 'ig');

			// Поиск содержания элемента
			walk(elem);

			// Запускаем возвратную функцию
			callback && callback(elem.find('.match'));

		});
	};

	$.fn.highlightRestore = function() {
		
		return this.each(function() {
			var elem = $(this);
			elem.html(elem.data('highlight-original'));
		});
		
	};

	function walk(elem) {

		elem.contents().each(function() {

			if (this.nodeType == 3) { // Текстовой узел

				if (termPattern.test(this.nodeValue)) {
					$(this).replaceWith(this.nodeValue.replace(termPattern, '<span class="match">$1</span>'));
				}
			} else {
				walk($(this));
			}
		});
	}

})(jQuery); 

И вот наш текст наполнен выделениями!

Вот так нужно использовать наш плагин:

$(function() {

	var search = $('#search'),
		content = $('#content'),
		matches = $(), index = 0;

	// Вылавливаем событие ввода текста
	search.on('input', function(e) {

		// Искать будем только строки больше 2 символов
		if (search.val().length >= 2) {
			
			// Используем плигин highlight для выделения текста
			content.highlight(search.val(), function(found) {

				matches = found;

				if(matches.length && content.is(':not(:animated)')){
					scroll(0);
				}
				
			});
		} else {
			content.highlightRestore();
		}

	});
	
	search.on('keypress', function(e) {
		
		if(e.keyCode == 13){ // Клавиша Enter
			scrollNext();
		}
		
	});


	function scroll(i){
		index = i;
		
		// Запускаем плагин scrollTo. Ограничиваем
		// движение осью y(только вертикальная прокурутка)
		content.scrollTo(matches.eq(i), 800, { axis:'y' } );
	}
	
	function scrollNext(){
		matches.length && scroll( (index + 1) % matches.length );
	}
});

В возвратной функции запускается scroll(0). Так анимируется элемент #content, чтобы показать первое соответствие из серии. Есть еще одна функция для прокрутки  – scrollNext, которая вызывается, когда пользователь нажимает клавишу Enter. Так мы осуществляем переход на следующее соответствие.

Теперь миниатюрная система помощи готова к использованию!

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

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

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



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

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