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

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

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

Раунд 1. Добавление навигации по страницам

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

<nav id="paging">
    <a id="all" href="#" data-bind="click: function () { pageSize(ko.utils.unwrapObservable(people).length); currentPage(0); }, css: { disabled: pageSize() === ko.utils.unwrapObservable(people).length }">Show all</a>
    <a id="last" title="Last Page" href="#" data-bind="click: function() { currentPage(totalPages() - 1); }, css: { disabled: currentPage() === totalPages() - 1 }">Last</a>
    <a id="next" title="Next Page" href="#" data-bind="click: function (data, event) { navigate(event) }, css: { disabled: currentPage() === totalPages() - 1 }">»</a>
    <ul data-bind="template: 'pagingTemplate'"></ul>
    <a id="prev" title="Previous Page" href="#" data-bind="click: function (data, event) { navigate(event) }, css: { disabled: currentPage() === 0 }">«</a>
    <a id="first" title="First Page" href="#" data-bind="click: function() { currentPage(0); }, css: { disabled: currentPage() === 0 }">First</a>
</nav>
<label id="pageSize">Show <input data-bind="value: pageSize" /> per page</label>
<script id="pagingTemplate" type="text/x-jquery-tmpl">
    {{each(i) ko.utils.range(1, totalPages)}}
        <li>
            <a href="#" title="View page ${ i + 1 }" data-bind="click: function() { currentPage(i) }, css: { on: i === currentPage() }">${ i + 1 }</a>
        </li>
    {{/each}}
<script>

Только что мы добавили на страницу блок <nav>, который содержит следующие блоки:

• ссылку на показ всех контактов;
• ссылку на предыдущую страницу;
• ссылку на следующую страницу;
• ссылку на первую страницу;
• ссылку на последнюю страницу.

Также мы создали пустой список <ul>, который будет заполняться ссылками на каждую отдельную страницу, в зависимости от числа контактов, которые мы выбрали.

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

Функция, которую мы написали, просто обновляет значение свойства pageSize в модели представления (которое мы ещё туда не добавили, но совсем скоро это сделаем). Задаваемое значение - это не что иное как количество контактов, выводимых на одну страницу. Также мы задаём и другое подобное свойство (currentPage), изначально равное 0, которое предназначено для хранения номера текущей страницы.

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

Связка css позволяет назначить элементу то или иное свойство, если результат внутренней проверки вернёт true. Первое, что мы проверяем, так это равно ли количество элементов, которые мы хотим выводить (pageSize), количеству элементов в массиве people. Если да, и все контакты поместились на одну страницу, то элементу будет приписано значение disabled.

Ссылкам на первую, последнюю, следующую и предыдущую страницы мы также приписали связки к click и css. С первой страницей всё просто: выставляем свойству currentPage значение 0. Ссылка будет не активной, если текущая страница является первой. Последний номер страницы формируется согласно общему числу страниц, и данная ссылка будет не активной, если текущая страница - последняя.

В результате кликов на кнопки следующая или предыдущая, вызывается метод navigate, куда мы передаём объект, на который нажал пользователь. Как именно работает данный метод, мы увидим чуть позже. К обоим данным ссылкам мы также привязали свойство css. Ссылка на следующую страницу будет активна, если активна ссылка на последнюю страницу. Соответственно, ссылка на предыдущую страницу будет активна, если активна ссылка на первую страницу.

Содержание списка <ul> мы формируем с помощью jQuery шаблона. На этот раз мы воспользовались другим синтаксисом блока {{each(i) ... }}.

После элемента <nav> мы помещаем на страницу специальный элемент <input>, через который будем задавать, какое количество контактов следует выводить на страницу. Данное значение в последствии мы привяжем к модели представления для того, чтобы изменение значения сразу же отражалось на всём приложении.

Итак, после всего этого, в реализации шаблона, в цикле {{each}} проходимся по числу сгенерированных номеров страниц и выводим их. Общее число страниц считаем с помощью knockout-овского метода range. Этот метод принимает минимальное значение (к примеру, 1), затем максимальное (которое мы получаем из модели представления).

Каждая ссылка на страницу представляет из себя элемент списка <li>, содержащий ссылку <a>. Значение атрибута href равно “#”. Knockout проследит, чтобы страница не перезагружалась. При нажатии на каждую из ссылок, происходит изменение значения currentPage, а также определение css стиля для текущей сслыки.

Также после всего этого нам нужно сделать некоторые изменения в контейнере #people. В месте, где у нас стоит ключевое слово foreach, после знака : меняем значение people на showCurrentPage.

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

Раунд 2. Редактируем модель представления

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

currentPage: ko.observable(0),
pageSize: ko.observable(5),
navigate: function (e) {
    var el = e.target;

    if (el.id === "next") {
        if (this.currentPage() < ko.utils.unwrapObservable(this.totalPages()) - 1) {
            this.currentPage(this.currentPage() + 1);
        }
    } else {
        if (this.currentPage() > 0) {
            this.currentPage(this.currentPage() - 1);
        }
    }
}

Это конечно не всё, что нам нужно, но давайте сначала разберём этот кусок, а потом перейдём к оставшейся части. Первые два свойства - это, по сути, наблюдатели за простым цифровым значением. Как мы уже говорили, currentPage представляет из себя номер текущей страницы, pageSize - количество контактов, выводимых на страницу.

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

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

Вы наверное заметили, что внутри данного блока мы активно пользуемся словом this. Knockout автоматически ссылает его на текущий объект модели представления.

Всё что нам осталось, так это добавить ещё 3 метода, но из-за их особенностей мы сделаем это за пределами объекта viewModel.

Раунд 3. Зависимые наблюдатели

Термин “зависимый наблюдатель“ - это ещё одно понятие в пределах кnockout.js, которое позволяет нам реализовать связь между каким-то объектом и моделью представления.

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

Сразу же после объекта модели представления (но перед вызовом applyBindings), вставьте следующий код:

viewModel.totalPages = ko.dependentObservable(function () {
        return Math.ceil(ko.utils.unwrapObservable(this.people).length / this.pageSize());
    }, viewModel);

    viewModel.showCurrentPage = ko.dependentObservable(function () {
        if (this.currentPage() > Math.ceil(ko.utils.unwrapObservable(this.people).length / this.pageSize())) {
            this.currentPage(ko.utils.unwrapObservable(this.totalPages()) - 1);
        }
        var startIndex = this.pageSize() * this.currentPage();
        return this.people.slice(startIndex, startIndex + this.pageSize());
    }, viewModel);

    viewModel.numericPageSize = ko.dependentObservable(function () {
        if (typeof (this.pageSize()) !== "number") {
            this.pageSize(parseInt(this.pageSize()));
        }
    }, viewModel);

Поскольку данные методы являются “зависимыми наблюдателями“, мы их выносим за предел объекта модели представления. Когда мы определяем какую-то функцию, то передаём viewModel в метод dependantObservable, для того чтобы слово this ссылалось на модель представления.

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

Метод showCurrentPage используется нами в самом представлении. В нём мы сначала мы проверяем, не является ли значение currentPage больше, чем то, что пришло к нам от метода totalPages. На первый взгляд, данная проверка не очень нужна, но поверьте, она сыграет свою роль в некоторых ситуациях. Если currentPage больше того значения, которое пришло от totalPages, то ставим currentPage значение последней страницы.

После этого нам нужно определить индекс, начиная с которого мы будем выводить контакты из массива people. Для этого можем воспользоваться двумя значениями pageSize и currentPage.

Наш последний метод наблюдает за значением свойсвтва pageSize. Оно берётся из элемента input, о котором мы говорили раньше. Тут главным моментом является преобразование строкового значения в число. Если этого не сделать, то в определённых условиях может возникнуть ошибка.

Итак, наш второй демо пример готов. Теперь можем посмотреть, что у нас получилось. Результат должен быть такой:

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

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

Сначала мы добавили html-я и создали шаблон вывода номеров страниц и ссылки. Научились ещё одним способом использовать цикл each. Воспользовались методом unwrapObservable для получения правильных данных от тех переменных, чьё значение меняется в режиме реального времени.

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

Мы уже сделали не мало, но дальше нас ждёт ещё много чего интересного. Что вы теперь думаете о knockout.js?

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