Знакомство с knockout.js (часть 3/3)

В заключительной части знакомства с knockout.js мы добавим ещё несколько фишек к тому, что делали в предыдущих двух уроках. Мы уже разобрали фундаментальные основы библиотеки: привязку данных, шаблонизатор, наблюдателей и так далее. В этом уроке, мы закрепим наши знания.

В этом уроке мы реализуем довольно-таки сложную задачу: фильтрацию контактов по первым буквам их имени. Также посмотрим, как можно организовать простой поиск. Давайте же начнём.

Раунд 1 - Начинаем

Начнём мы с добавления html кода в index.html. Добавьте следующий код сразу же после открывающегося тега <body>:

<div id="alphaFilter">
<span>Filter name by:</span>
<ul data-bind="template: 'letterTemplate'"></ul>
<a id="clear" href="#" title="Clear Filter" data-bind="click: clearLetter, css: { disabled: filterLetter() === '' }">Clear filter</a>
<fieldset id="searchForm">
   <span>Search for:</span>
   <button data-bind="click: setTerm, disable: filterTerm" type="button">Go</button>
   <input id="term">
   <a data-bind="visible: filterTerm, click: clearTerm" title="Clear search" href="#">x</a>
</fieldset>
</div>
<script id="letterTemplate" type="text/x-jquery-tmpl">
{{each(i, val) letters}}
   <li>
      <a href="#" title="Filter name by ${ val }" data-bind="click: function() {
         filterLetter(val) },
         css: { disabled: val === filterLetter() }">
         ${ val }
      </a>
   </li>
{{/each}}
</script>

Сначала добавим небольшой контейнер для новых элементов интерфейса. Для того чтобы мы могли оформлять новые элементы, зададим контейнеру id. Внутри контейнера создаём <span> с алфавитом, по которому будет осуществляться фильтрация. Перечислять буквы мы будем в коде, поэтому свяжем данный элемент атрибутом data-bind.

После списка букв помещаем ссылку для сброса фильтрации и привязываем к ней два события: первый - это click, который мы позже реализуем в модели представления. Второй - css, для определения активности ссылки сброса фильтрации.

Всё что касается поиска, помещаем в элемент <fieldset>. Здесь у нас будет кнопка и простое текстовое поле, куда мы будем вводить текст для поиска по карточкам с контактами.

К элементу <button> привязываем события click и disabled. Click будем использовать для вызова функционала поиска; disabled - для определения активности кнопки поиска, в зависимости от значения переменной filterTerm. Кнопке сброса тоже назначаем несколько событий, для того чтобы она отображалась, когда задана какая-то фильтрация, и чтобы исчезала, когда все настройки сброшены.

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

Массив данных из модели представления будем прокручивать в цикле {{each}}. Какдый элемент помещаем в <li> и <a>. Из переменной val, переданную в шаблон, мы сможем вытащить данные для атрибута title. Также, тут каждому элементу мы назначаем click привязку filterLetter, обработку которой осуществим в модели представления.

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

Раунд 2 - Обновляем модель представления

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

filterLetter: ko.observable(""),
filterTerm: ko.observable(""),
clearLetter: function () {
  this.filterLetter("");
},
clearTerm: function () {
  this.filterTerm("");
$("#term").val("");
},
setTerm: function () {
  this.filterTerm($("#term").val());
}

Для начала мы добавляем несколько наблюдателей: filterLetter, для хранения текущей буквы; filterTerm для хранения текущей строки поиска. По умолчанию значения данных полей пустые.

Также пишем парочку методов: clearLetter, который сбрасывает значение поля filterLetter; clearTerm для сброса поля filterTerm. Также данный метод будет сбрасывать значение поля поиска. Последний метод setTerm, предназначен для задания значения для поля filterTerm.

Раунд 3 - Фильтрация по фрагменту строки

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

viewModel.filteredPeopleByTerm = ko.dependentObservable(function () {
var term = this.filterTerm().toLowerCase();

if (!term) {
   return this.people();
}

return ko.utils.arrayFilter(this.people(), function (person) {
   var found = false;

   for (var prop in person) {
      if (typeof (person[prop]) === "string") {
         if (person[prop].toLowerCase().search(term) !== -1) {
            found = true;
            break;
         }
      }
   }

   return found;
});

}, viewModel);

Сначала мы преобразуем все символы строки в прописные для упрощения поиска. Если строка поиска пуста, то функция возвращает полный массив элементов. Если поисковое поле содержит строку, то применяем arrayFilter() для фильтрации массива. Данный метод принимает массив, перебирает каждый элемент, и если тот подходит, оставляет его в массиве.

Процесс выглядит примерно так: сначала мы задаём переменной-флагу значение false. Затем проходимся по каждому полю всех элементов массива. Если текущее поле содержит строку, то мы проверяем соответствие, предварительно преобразовав строку в нижний регистр и воспользовавшись нативным методом search(). Данный метод возвращает -1, если искомый фрагмент не найден в строке. В случае, если фрагмент найден, меняем значение флага на true и завершаем прохождение по полям записи.

После того как мы пройдёмся по всем элементам, переменная-флаг будет равна true или false. В методе arrayFilter мы просто-напросто выбираем подходящие нам записи и возвращаем их. Таким образом, полученный массив можем задействовать в других местах кода.

Раунд 4 - Фильтрация по буквам

Далее нам необходимо сформировать массив букв:

viewModel.letters = ko.dependentObservable(function () {
var result = [];

ko.utils.arrayForEach(this.filteredPeopleByTerm(), function (person) {
   result.push(person.name.charAt(0).toUpperCase());
});

return ko.utils.arrayGetDistinctValues(result.sort());
}, viewModel);

Сначала мы создаём пустой массив result. Далее используем метод arrayForEach самого Knockout, для того чтобы пройтись по всем карточкам и собрать буквы. Передвигаясь по элементам, мы берём значения и записываем их в массив result. Затем пропускаем его через метод arrayGetDistinctValues() для удаления дубликатов.

Раунд 5 - Фильтрация

Последнее, что нам нужно добавить, так это обработчик, который будет срабатывать при изменении буквы фильтрации:

viewModel.filteredPeople = ko.dependentObservable(function () {
    var letter = this.filterLetter();
    if (!letter) {
        return this.filteredPeopleByTerm();
    }

    return ko.utils.arrayFilter(this.filteredPeopleByTerm(), function (person) {
        return person.name.charAt(0).toUpperCase() === letter;
    });
}, viewModel);

Если значение letter будет равно false, то мы просто возвращаем массив, пропущенный через filteredPeopleByTerm без изменений.

Если же пользователь выбрал какую-то букву, то мы должны применить фильтр arrayFilter(). Преобразуем все первые буквы в заглавные и возвращаем результат. Заметьте, что данные останутся в отфильтрованном массиве, если наша анонимная функция вернёт true.

Раунд 6 - Обновление постраничной навигации

В прошлом уроке мы создали постраничную навигацию на основе массива people. Для того, чтобы всё работало правильно после фильтрации, нам необходимо обновить showCurrentPage. Также нам нужно возвращать массив контактов, которые подходят под текущий фильтр:

return this.filteredPeople().slice(startIndex, startIndex + this.pageSize());

Вот и всё. Теперь наш функционал фильтрации по буквам и полю поиска должны работать. Удобно, когда есть несколько вариантов.

Результат боя

В заключительной части, посвящённой введению в Knockout, мы закрепили полученные знания и навыки. Создали систему фильтрации, преобразовав модель представления. Надеюсь, вы убедились в том, что с Knockout.js намного легче реализовывать подобный функционал.

Реализовав синхранизацию данных, мы также рассмотрели, как можно использовать методы arrayGetDistinctValues(), и arrayFilter().

Вот и всё. Надеюсь, вам понравился Knockout.js. С ним действительно проще создавать сложные, интерактивные JavaScript приложения.

• Комментарии