JQuery UI Autocomplete — Использование виджета автозаполнения. Виджет Autocomplete. Автозаполнение

Опция source используется для указания источника предложения для меню Autocomplete. Мы используем функцию, как значение для данной опции, которая принимает два аргумента. Первый является термином, введенным в , а второй - возвратной функцией, которая используется для передачи предложений обратно виджету.

В данной функции мы используем метод jQuery getJSON() для передачи термина в PHP файл на стороне сервера. Файл PHP использует термин для извлечения похожих имен контакта из базы данных MySql. Мы используем JSONP для возвращения полученных данных обратно процессу. Возвратная функция, которая передается как второй аргумент опции source, предполагает получение данных в массиве. Таким образом нужно создать пустой массив и использовать метод jQuery each() для обработки каждого пункта массива JSON, который возвращается сервером. Итерация совершается над каждым пунктом в массиве и добавляет каждое предложение в новый массив. Как только новый массив будет построен, мы передаем его возвратной функции для вывода виджетом в меню.

Затем определяется обработчик для события select Autocomplete. Данная функция выполняется виджетом каждый раз, когда предложение выделяется в меню Autocomplete. Данная функция автоматически получает два аргумента - объект события и объект ui, который содержит выбранное предложение. Мы используем данную функцию для форматирования имени получателя и добавления его в . Просто создается элемент для текста и элемента ссылки, которая используется для удаления получателя. Как только форматированное имя получателя будет создано, оно вставляется прямо перед закамуфлированным .

Затем мы добавляем обработчик события change. Данная функция будет вызвана при изменениях значения , с которым ассоциирован Autocomplete. Мы просто удаляем значение из , потому что мы уже добавляли форматированную версию в контейнер .

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

//Добавляем обработчки события click для div friends $("#friends").click(function(){ //Фокусируемся на поле "Кому" $("#to").focus(); }); //Добавляем обработчик для события click удаленным ссылкам $(".remove", document.getElementById("friends")).live("click", function(){ //Удаляем текущее поле $(this).parent().remove(); //Корректируем положение поля "Кому" if($("#friends span").length === 0) { $("#to").css("top", 0); } });

, к которому прикреплен наш Autocomplete, практически скрыт и контейнер имеет стиль, который делает его похожим на другие поля формы. Для завершения обмана мы добавляем обработчик события click контейнеру , таким образом нажатие клавиши мыши где-угодно на нем фокусирует действительный . Теперь визуально и функционально не отличается от обычного поля.

Также нужно обрабатывать событие click на ссылке, которая добавляется для каждого форматированного имени получателя. Мы используем метод jQuery live() потому, что данный элемент может и не существовать на странице в заданное время, и такой подход проще, чем привязывание функции обработчика каждый раз, когда создается ссылка. Когда бы не была нажат ссылка, все что нужно сделать, это перейти к родителю ссылки и затем удалить ее со страницы. Нужно проверить, удалены ли все имена получателей, и если это так, то сбросить положение к значению по умолчанию.

Для хранения списка всех имен получателей используется база данных MySql. Следующий файл PHP получает данные, отправленные методом getJSON() и вытаскивает соответствующие имена получателей из базы данных:

Для запуска примера нужен веб сервер с установленным и сконфигурированным PHP, а также сервер MySql и соответствующая база данных и таблица. Когда символ вводится в поле ‘Кому’, он передается на сревер и используется для вытаскивания из базы данных каждого имени, которое начинается с введенного символа. Подходящие имена затем передаются обратно на страницу и выводятся в меню предложений:

Наша форма в действительности ничего никуда не отправляет. Функционал легко реализовать с помощью обработки события, привязанного к кнопке "Отправить".

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

Виджет Autocomplete

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

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

jQuery UI $(function() { var flowers = ["Астра", "Нарцисс", "Роза", "Пион", "Примула", "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка"]; $("#acInput").autocomplete({ source: flowers }) }); Выберите название цветка:

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

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

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

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

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

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

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

В этом сценарии используется тот же набор названий цветов, что и в предыдущем примере, и возвращаются значения, которые соответствуют поисковому выражению, определяемому ключевым словом 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 поддерживает ряд методов, которые можно использовать для управления процессом автозаполнения. Эти методы перечислены в таблице ниже:

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

... $(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; } }) }); п с Содержимое вывода Закрыть Выберите название цветка:

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

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

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

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

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

... $(function() { var flowers = ["Астра", "Нарцисс", "Роза", "Пион", "Примула", "Подснежник", "Мак", "Первоцвет", "Петуния", "Фиалка"]; $("#acInput").autocomplete({ source: flowers, focus: displayItem, select: displayItem, change: displayItem }) function displayItem(event, ui) { $("#itemLabel").text(ui.item.label) } }); Выберите название цветка: Значение элемента:

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

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

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

... $(function() { var flowers = ["Астра", "Нарцисс", "Роза"]; var skus = {Астра: 100, Нарцисс: 101, Роза: 102}; $("#acInput").autocomplete({ source: flowers, select: function(event, ui) { $("#sku").val(skus); } }) }); Выберите название цветка: Отдел склада:

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

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

a! Представляю Вам очередную статью в рубрике «Плагины». Рассмотрим плагин jQuery-Autocomplete , с помощью которого легко создать автозаполнение текстовых полей формы. Работает только на jQuery, для хранение значений автозаполнения можно использовать текстовый файл.

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

Теперь вызываем метод .autocomplete :

В приведенном примере метод .autocomplete вызывается с 2мя параметрами, lookup где
countriesArray — это массив со странами, о нем и как он формируется немного ниже, а также onSelect — функция обратного вызова при выборе элемента из предложенного списка.

• serviceUrl — путь до файла с значениями.
• lookup — массив значений. Это может быть массив строк или:
  • suggestion — литерал объекта в формате { value: ‘string’, data: any }
• lookupFilter — function (suggestion, query, queryLowerCase) {} Функция фильтрации для поиска в массиве. По умолчанию частичное совпадение строк (без учета регистра);
• onSelect — Callback функция, вызывается когда пользователь выбирает значение из предложенного списка;
• minChars — Минимальное количество символов, необходимых для запуска автозаполнения. По умолчанию: 1;
• maxHeight — Максимальная высота контейнера со списком значений, в пикселях. По умолчанию: 300;
• deferRequestBy — Количество миллисекунд задержки AJAX запроса. По умолчанию: 0;
• width — Ширина контейнера со списком значений автозаполнения в пикселях, например: 300. По умолчанию: auto;
• params — Дополнительные параметры, передаваемые с запросом, необязательно.
• formatResult — function (suggestion, currentValue) {} пользовательские функции, необязательно.
• delimiter — Строка или RegExp, который разбивает входное значение. Полезно когда, например, вам нужно заполнить список значений, разделенных запятыми;
• zIndex — свойство css zIndex для контейнера со списком предложений. По умолчанию: 9999;
• type — тип Ajax запроса. По умолчанию: GET ;
• noCache — Логическое значение, указывающее, следует ли кэшировать результаты списка предложений. По умолчанию True.
• onSearchStart — function (query) {} вызывается перед запроса AJAX. this связано с input элементом;
• onSearchComplete — function (query) {} вызывается после запроса AJAX. this связано с input элементом;
• tabDisabled — по-умолчанию false . Устанавливает курсор ввода после выбора предложенного значения;
• paramName — по-умолчанию query . Имя параметра запроса, который содержит запрос;
• transformResult — function(response) {} Вызывается после того, как станет готов результат запроса. Преобразует результат в response.suggestions формат;
• autoSelectFirst — если установлено true , первый пункт будет подсвечен при показе списка предложений. Значение по-умолчанию false ;
• appendTo — контейнер, в который будет добавлен список предложений. По-умолчанию body . Может быть JQuery объект, селектор или HTML элемент. Убедитесь в том, чтобы было установлено position: absolute или position: relative для этого элемента.

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

Где с помощью метода $.map переводим все элементы массива из файла в новый массив со значениями.

Структура списка предложений выглядит так:

И применяется простое оформление.

Последнее обновление: 1.11.2015

Виджет autocomplete предназначен для создания специальных полей ввода с функцией автозаполнения:

В качестве источника автозаполнения указываем какой-нибудь массив и потом применяем виджет.

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

Выходная переменная $output содержит весь список в формате json. В реальности, конечно, все элементы списка, скорее всего, будут извлекаться из БД, но я для простоты упростил пример.

По сути каждый элемент списка - это объект, у которого определены два свойства: label (отображаемая метка) и value (само значение). В данном случае оба свойства по значению совпадают.

На стороне клиента прием мог бы выглядеть следующим образом:

$("input#lang").autocomplete({ source: function(request,response) { $.getJSON("json.php", { filter: $("input#lang").val() }, function(data){ var suggestions = ; // массив для хранения результатов $.each(data, function(key, val) { suggestions.push(val.value); // добавляем все элементы }); response(suggestions); }); } });

Таким образом, мы динамически получаем введенные в поле ввода символы и передаем их в запросе на сервер. На сервере эти символы используются в качестве фильтра, а в ответ клиенту возвращается набор отфильтрованных записей.

При применении виджета к элементу input к данному элементу добавляется класс ui-autocomplete-input . А область списка автозаполения представляет собой список ul: