Виджет Autocomplete

128

Веб-программирование --- jQuery UI --- Виджет Autocomplete

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

Создание виджета Autocomplete

Чтобы создать элемент управления автозаполнением, следует вызвать метод autocomplete() для соответствующего элемента input. Пример использования этого метода, в котором демонстрируется базовая функциональность виджета Autocomplete, приведен ниже:

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>jQuery UI</title>
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
    <script src="//ajax.aspnetcdn.com/ajax/jquery.ui/1.10.3/jquery-ui.min.js"></script>
    <link rel="stylesheet" href="http://ajax.aspnetcdn.com/ajax/jquery.ui/1.10.3/themes/sunny/jquery-ui.css">
    <script type="text/javascript">
        $(function() {

            var flowers = ["Астра", "Нарцисс", "Роза", "Пион", "Примула",
			      "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка"];
            
            $('#acInput').autocomplete({
                source: flowers
            })
        });
    </script>
</head>
<body>
    <form>
        <div class="ui-widget">
            <label for="acInput">Выберите название цветка: </label>
            <input id="acInput"/>
        </div>
    </form>
</body>
</html>

Метод autocomplete() работает аналогично любому другому методу jQuery UI из тех, с которыми вы уже познакомились, за исключением того, что ему необходимо передавать объект отображения, содержащий значение опции source. Эта опция позволяет указать источник, из которого должны извлекаться данные для автозаполнения. В примере роль такого источника играет простой массив значений.

На рисунках ниже показано, в каком виде средство автозаполнения предстает перед пользователем:

Базовая реализация функции автозаполнения

Сужение области поиска функции автозаполнения

На этом рисунке представлены два экранных снимка. Первый из них соответствует ситуации, когда пользователь вводит букву "а". Вы видите, что это приводит к появлению списка цветов, названия которых включают букву "а". В список вошли не только астры, название которых начинается с буквы "а", но и названия других цветов, в которых также содержится буква "а".

После ввода второй буквы ("к") список сокращается до одного названия (Мак), содержащего введенное сочетание букв ("ак"). Виджет Autocomplete не проверяет правильность введенных данных, и пользователь может вводить в текстовом поле любые значения, а не только те, которые определены опцией source.

Заметьте, что никаких специальных мер по сортировке массива, указанного с помощью опции source, мы не предпринимали. За нас это автоматически сделала библиотека jQuery UI. Кроме того, как будет показано далее, возможные варианты продолжения ввода могут поступать из нескольких источников.

В приведенном примере документа элементы input и label помещены в элемент div, которому присвоен класс ui-widget. Тем самым обеспечивается совпадение CSS-свойств шрифтов, используемых в этих элементах и в раскрывающемся списке виджета Autocomplete.

Использование массива объектов в качестве источника данных

В качестве источника элементов списка автозаполнения вместо строк могут использоваться массивы объектов. Это дает возможность отделить ярлык, отображаемый в раскрывающемся списке, от значения, подставляемого в текстовое поле. Соответствующий демонстрационный пример приведен ниже:

$(function() {

    var flowers = [{label: "Астры (бордовые)", value: "Астры"}, 
			       {label: "Нарциссы(белые)", value: "Нарциссы"}, 
			       {label: "Розы (розовые)", value: "Розы"}, 
			       {label: "Пионы (розовые)", value: "Пионы"}]
            
    $('#acInput').autocomplete({
                source: flowers
    })
});

Когда используется массив объектов, средство автозаполнения ищет свойства label и value. Свойство label используется для создания ярлыков, отображаемых в раскрывающемся списке, а свойство value — для вставки значений в поле ввода при выборе соответствующего ярлыка. В данном случае ярлыки содержат информацию об оттенках цветов, которая не включается в значения. Результат приведен на рисунке:

Настройка виджета Autocomplete

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

Свойства виджета Autocomplete
Свойство	Описание
appendTo	Определяет элемент, к которому должен быть присоединен раскрывающийся список элементов автозаполнения. По умолчанию таковым является элемент body
autoFocus	Если эта опция равна true, то фокус автоматически устанавливается на первом элементе раскрывающегося списка, что позволяет выбирать его простым нажатием клавиши `<Enter>`. Значение по умолчанию — false
delay	Устанавливает длительность периода задержки (в миллисекундах) после нажатия клавиши, по истечении которого будет срабатывать автозаполнение. Значение по умолчанию — 300
disabled	Установка значения true приводит к отключению средства автозаполнения. На базовый элемент input эта опция никакого влияния не оказывает. Значение по умолчанию — false
minLength	Определяет минимальное число символов, ввод которых будет инициировать отображение раскрывающегося списка элементов автозаполнения. Значение по умолчанию — 1
source	Устанавливает источник данных для добавления в раскрывающийся список элементов автозаполнения. Значения по умолчанию для этого свойства не существует, и поэтому указание необходимого значения при вызове метода autocomplete() является обязательным

Использование дистанционного источника данных

Из всех настроек виджета Autocomplete наибольший интерес представляет опция source, поскольку она обеспечивает возможность выбора самых различных источников данных для включения в раскрывающийся список элементов автозаполнения. С ролью простых статических списков отлично справляются массивы JavaScript, которые использовались в предыдущем примере. В более сложных ситуациях необходимые данные могут поступать с сервера. Для этого потребуется лишь указать URL-адрес источника данных, как показано в примере ниже:

$(function() {
            
    $('#acInput').autocomplete({
                source: 'phphandler.php'
    })
	
});

Как только средству автозаполнения понадобятся данные, jQuery UI выполнит HTTP-запрос по указанному URL-адресу, используя метод GET. Введенные к этому времени пользователем символы включаются в строку запроса с помощью ключевого слова term. Например, если пользователь введет букву "a", то jQuery UI направит следующий запрос:

http://localhost/phphandler.php?term=a

Если далее будет введена буква "c", то запрос станет таким:

http://localhost/phphandler.php?term=ac

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

За получение значения term из строки запроса и возврат JSON-строки, представляющей массив элементов, отображаемых для пользователя, отвечает сервер. Простой серверный сценарий PHP, пригодный для этих целей, приведен ниже:

<?php
	// Исходный массив
	$flowers = array("Астра", "Нарцисс", "Роза", "Пион", "Примула",
			      "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка");
	
	if (!empty($_GET['term']))       
    {
        $term = $_GET['term'];
		
		// Шаблон рег. выражения
		$pattern = '/^'.preg_quote($term).'/iu';
		
		echo json_encode(preg_grep($pattern, $flowers));
    }
	
?>

В этом сценарии используется тот же набор названий цветов, что и в предыдущем примере, и возвращаются значения, которые соответствуют поисковому выражению, определяемому ключевым словом term запроса, полученного от браузера. Я незначительно изменил процедуру поиска таким образом, чтобы возвращались лишь те названия цветов, которые начинаются с поискового термина. Так, если jQuery UI отправляет строку запроса http://localhost/phphandler.php?term=a то сервер возвращает следующие данные JSON: ["Астры"].

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

Получение данных для автозаполнения с удаленного сервера

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

Имеется возможность управлять частотой отправки запросов средством автозаполнения с помощью опций minLength и delay. Опция minLength позволяет указать минимальное количество символов, которые пользователь должен ввести, прежде чем jQuery UI направит соответствующий запрос серверу. Таким образом, к моменту отправки запроса пользователем уже будет введено несколько символов, и этой информации вам будет вполне достаточно, чтобы сузить область поиска.

С помощью опции delay можно указать время, которое должно пройти с момента ввода символа, прежде чем будет сделан запрос. Это позволяет избежать неоправданно частой отправки запросов при высокой скорости набора символов пользователем. Так, если пользователь введет буквы "a" и "c", то будет направлен только один запрос, соответствующий комбинации "ac", а не два мгновенно следующих один за другим отдельных запроса, соответствующих наборам букв "a" и "ac".

Совместно используя обе опции, можно уменьшить количество запросов и при этом по-прежнему предоставлять пользователю достаточный объем необходимой информации. Пример использования описанных опций настройки приведен ниже:

$(function() {
            
    $('#acInput').autocomplete({
                source: 'phphandler.php',
				minLength: 3,
				delay: 1000
    })
	
});

В этом примере запрос будет инициироваться лишь после того, как пользователь наберет три символа, и при условии, что в течение одной секунды после этого не будет введен ни один дополнительный символ.

Использование функции в качестве источника данных

Для создания источника элементов автозаполнения, в полной мере приспособленного к конкретным потребностям пользователей, можно использовать функцию. Эта функция также указывается с помощью опции source и вызывается всякий раз, когда средство автозаполнения должно отображать возможные варианты продолжения ввода для пользователей. Соответствующий пример приведен ниже:

$(function() {
	
	var flowers = ["Астра", "Нарцисс", "Роза", "Пион", "Примула",
			      "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка"];
            
    $('#acInput').autocomplete({
                source: function(request, response) {
                    var term = request.term;
                    var pattern = new RegExp("^" + term, "i");
                    
                    var results = $.map(flowers, function(elem) {                       
                        if (pattern.test(elem)) {
                            return elem;
                        }
                    })                    
                    response(results);
				}
    })
	
});

Мы передаем этой функции два аргумента. Один из них — это объект с единственным свойством term. Значением этого свойства является строка символов, введенных пользователем. Второй аргумент — это функция, которая вызывается, когда уже сгенерирован список элементов автозаполнения для отображения пользователю. Аргументом этой функции является массив строк или объектов.

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

Данный способ обработки результатов не совсем обычен, но работает вполне удовлетворительно, и генерируемые элементы отображаются для пользователя, так что конечный результат получается тем же, что и в случае применения серверного сценария PHP.

Использование методов виджета Autocomplete

Виджет Autocomplete поддерживает ряд методов, которые можно использовать для управления процессом автозаполнения. Эти методы перечислены в таблице ниже:

Методы виджета Autocomplete
Метод	Описание
autocomplete("close")	Закрывает раскрывающийся список элементов автозаполнения
autocomplete("destroy")	Полностью удаляет функциональность автозаполнения из элемента input
autocomplete("disable")	Приостанавливает работу виджета Autocomplete для базового элемента
autocomplete("enable")	Возобновляет работу ранее приостановленного виджета Autocomplete
autocomplete("option")	Устанавливает значения одного или нескольких свойств
autocomplete("search", значение)	Запускает процедуру поиска элементов автозаполнения, соответствующих указанному значению. Если аргумент значение не предоставлен, используется содержимое элемента input

Специфичными для средства автозаполнения являются два метода — search и close. Их можно использовать для программного запуска и остановки процесса автозаполнения, как показано в примере ниже:

<!DOCTYPE html>
...
    <script type="text/javascript">
$(function() {
	
	var flowers = ["Астра", "Нарцисс", "Роза", "Пион", "Примула",
			      "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка"];
            
    $('#acInput').autocomplete({
                source: flowers,
                minLength: 0,
                delay: 0
            })
            
            $('button').click(function(e) {
                e.preventDefault();
                switch (this.id) {
                    case "close":                                         
                        $('#acInput').autocomplete("close");
                        break;
                    case "input":                           
                        $('#acInput').autocomplete("search");
                        break;
                    default:            
                        $('#acInput').autocomplete("search", this.id);
                        break;
                }
            })
        });
    </script>
</head>
<body>
    <form>
        <button id="п">п</button>
        <button id="с">с</button>
        <button id="input">Содержимое вывода</button>
        <button id="close">Закрыть</button>        
        <div class="ui-widget">
            <label for="acInput">Выберите название цветка: </label>
            <input id="acInput"/>
        </div>
    </form>
</body>

В этом примере мы добавили некоторые кнопки и использовали метод click() для настройки различных вызовов метода autocomplete(). При нажатии кнопок, обозначенных как "П" и "С", вызывается метод search, которому выбранная буква передается в качестве поискового выражения. Это приводит к запуску средства автозаполнения с использованием выбранной буквы, независимо от содержимого текстового поля, как показано на рисунке:

Использование метода search() с поисковым выражением

Как показано на рисунке, в раскрывающемся списке отображаются элементы, которые содержат букву, указанную на нажатой кнопке.

Кнопка "Содержимое ввода" запускает средство автозаполнения с использованием тех символов, которые содержатся в текстовом поле. При настройке средства автозаполнения свойству minLength было присвоено значение 0, в результате чего после щелчка на кнопке "Содержимое ввода" в списке ввода отображаются сразу все элементы автозаполнения, как показано на рисунке ниже. Если пользователь введет какие-либо символы в поле ввода, то отобразятся лишь элементы, содержащие введенную строку:

Поиск с использованием содержимого поля ввода

Использование событий виджета Autocomplete

С виджетом Autocomplete связан ряд событий, которые перечислены в таблице ниже:

События виджета Autocomplete
Событие	Описание
change	Происходит, когда фокус ввода выходит за пределы текстового поля после изменения содержащегося в нем значения
close	Происходит при закрытии раскрывающегося списка элементов автозаполнения
create	Происходит при инициализации экземпляра виджета Autocomplete для данного элемента
focus	Происходит, когда элемент автозаполнения получает фокус в раскрывающемся списке
open	Происходит при открытии раскрывающегося списка элементов автозаполнения
search	Происходит перед генерацией раскрывающегося списка элементов автозаполнения или перед поиском в нем подходящих элементов
select	Происходит при выборе элемента списка автозаполнения

Получение сведений о выбранном элементе

В jQuery UI можно получить дополнительную информацию о событии с помощью второго аргумента функции-обработчика, обычно обозначаемого как ui. В случае событий change, focus и select jQuery UI наделяет объект ui свойством item, возвращающим объект, который описывает выбранный или получивший фокус элемент раскрывающегося списка. Пример, в котором демонстрируется использование этой возможности для получения информации о выбранном элементе, приведен ниже:

<!DOCTYPE html>
...
    <script type="text/javascript">
$(function() {
	
	var flowers = ["Астра", "Нарцисс", "Роза", "Пион", "Примула",
			      "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка"];
            
    $('#acInput').autocomplete({
        source: flowers,
        focus: displayItem,
        select: displayItem,
        change: displayItem
    })
    
    function displayItem(event, ui) {
        $('#itemLabel').text(ui.item.label)
    }
});
    </script>
</head>
<body>
    <form>    
        <div class="ui-widget">
            <label for="acInput">Выберите название цветка: </label>
            <input id="acInput"/>
            Значение элемента: <span id="itemLabel"></span>  
        </div>
    </form>
</body>

В этом примере добавлен элемент span, который используется для отображения свойства label выбранного объекта. Объекты со свойствами label и value создаются jQuery UI даже тогда, когда вы задаете в опции source простой массив строк, поэтому одно из этих свойств объекта ui.item вам всегда приходится считывать. В данном примере для событий focus, select и change используется одна и та же функция, отображающая значение элемента. Результат представлен на рисунке:

Замена действия по умолчанию для события select

Для события select предусмотрено действие по умолчанию, которое заключается в замене содержимого элемента input содержимым свойства value элемента, выбранного в раскрывающемся списке. Это как раз то, что необходимо в большинстве случаев, но можно использовать данное событие и для того, чтобы либо дополнить действие по умолчанию, либо полностью отменить его и выполнить какие-то другие действия, которые вам нужны.

Пример дополнения действия по умолчанию установкой значения связанного текстового поля приведен ниже:

<!DOCTYPE html>
...
    <script type="text/javascript">
$(function() {
	
	var flowers = ["Астра", "Нарцисс", "Роза"];
	var skus = {Астра: 100, Нарцисс: 101, Роза: 102};
            
    $('#acInput').autocomplete({
        source: flowers,
        select: function(event, ui) {
            $('#sku').val(skus[ui.item.value]);
        }
    })
});
    </script>
</head>
<body>
    <form>    
        <div class="ui-widget">
            <label for="acInput">Выберите название цветка: </label>
            <input id="acInput"/>
            <label for="sku">Отдел склада: </label>
            <input id="sku"/> 
        </div>
    </form>
</body>

Когда происходит событие select, функция-обработчик использует аргумент ui для получения значения выбранного элемента и установки значения связанного поля, в данном случае — поля "Отдел склада", которое получается из объекта skus. Тем самым мы можем помогать пользователям, предоставляя значения по умолчанию для других полей на основе первоначального выбора.

Это может пригодиться во множестве ситуаций, особенно при выборе таких элементов, как адреса доставки. Результаты представлены на рисунке ниже:

Использование события select для заполнения другого поля