Посмотреть на GitHub

Table Cookie

Расширение Cookie для Bootstrap Table, используется для сохранения и восстановления состояния таблицы.

На этой странице

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

Использование

<script src="extensions/cookie/bootstrap-table-cookie.js"></script>

Примеры

Cookie

Опции

  • Атрибут: data-cookie

  • Тип: Boolean

  • Описание:

    Включать ли функцию сохранения в Cookie. При установке в true информация о пагинации, состоянии сортировки, условиях поиска и т.д. будет сохранена в Cookie.

  • Значение по умолчанию: false

cookieCustomStorageDelete

  • Атрибут: data-cookie-custom-storage-delete

  • Тип: function

  • Параметры

    • cookieName: имя значения, например, ключевое слово поиска

  • Описание:

    Использует пользовательскую функцию для удаления сохранённых значений. Эта функция должна быть реализована только если опция cookieStorage установлена в customStorage.

  • Значение по умолчанию: undefined

cookieCustomStorageGet

  • Атрибут: data-cookie-custom-storage-get

  • Тип: function

  • Параметры

    • cookieName: имя значения, например, ключевое слово поиска

  • Описание:

    Использует пользовательскую функцию для получения сохранённых значений. Эта функция должна быть реализована только если опция cookieStorage установлена в customStorage.

  • Значение по умолчанию: undefined

cookieCustomStorageSet

  • Атрибут: data-cookie-custom-storage-set

  • Тип: function

  • Параметры

    • cookieName: имя значения, например, ключевое слово поиска
    • value: значение для сохранения

  • Описание:

    Использует пользовательскую функцию для сохранения значения в хранилище. Эта функция должна быть реализована только если опция cookieStorage установлена в customStorage.

  • Значение по умолчанию: undefined

cookieDomain

  • Атрибут: data-cookie-domain

  • Тип: String

  • Описание:

    Устанавливает домен для Cookie. Обычно необходимо удалить префикс www., например example.com.

  • Значение по умолчанию: null

cookieExpire

  • Атрибут: data-cookie-expire

  • Тип: String

  • Описание:

    Устанавливает срок действия Cookie в формате 'число+единица'. Например, '2h' означает 2 часа. Поддерживаемые единицы времени: 's' (секунды), 'mi' (минуты), 'h' (часы), 'd' (дни), 'm' (месяцы), 'y' (годы).

  • Значение по умолчанию: 2h

cookieIdTable

  • Атрибут: data-cookie-id-table

  • Тип: String

  • Описание:

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

  • Значение по умолчанию: ''

cookiePath

  • Атрибут: data-cookie-path

  • Тип: String

  • Описание:

    Устанавливает путь для Cookie. По умолчанию используется путь текущей страницы, можно использовать для указания, что Cookie действуют на всём сайте или в определённом каталоге.

  • Значение по умолчанию: null

cookieSecure

  • Атрибут: data-cookie-secure

  • Тип: Boolean

  • Описание:

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

  • Значение по умолчанию: null

cookieSameSite

  • Атрибут: data-cookie-same-site

  • Тип: string

  • Описание:

    Устанавливает значение атрибута SameSite для cookie, дополнительную информацию можно найти в документации SameSite.

  • Значение по умолчанию: Lax

cookieStorage

  • Атрибут: data-cookie-storage

  • Тип: String

  • Описание:

    Устанавливает способ хранения, используемый расширением. Доступные значения: cookieStorage, localStorage, sessionStorage или customStorage.

    При использовании customStorage необходимо одновременно реализовать cookieCustomStorageGet, cookieCustomStorageSet и cookieCustomStorageDelete.

  • Значение по умолчанию: cookieStorage

cookiesEnabled

  • Атрибут: data-cookies-enabled

  • Тип: Array

  • Описание:

    Устанавливает массив атрибутов таблицы для сохранения, например sortOrder, sortName, sortPriority, pageNumber, pageList, hiddenColumns, searchText, filterControl и т.д.

  • Значение по умолчанию: ['bs.table.sortOrder', 'bs.table.sortName', 'bs.table.sortPriority', 'bs.table.pageNumber', 'bs.table.pageList', 'bs.table.hiddenColumns', 'bs.table.searchText', 'bs.table.filterControl', 'bs.table.cardView', 'bs.table.customView']

Методы

deleteCookie

  • Параметры: cookieName

  • Описание:

    Удаляет сохранённый cookie по имени.

getCookies

  • Параметры: undefined

  • Описание:

    Возвращает сохранённый cookie.

Автоматически сохраняемое состояние таблицы

Этот плагин автоматически сохраняет следующую информацию о состоянии таблицы:

  • Номер страницы: текущий номер страницы
  • Количество записей на странице: количество записей, отображаемых на странице
  • Текст поиска: ключевое слово поиска, введённое пользователем
  • Условия фильтрации: состояние фильтрации, установленное через filter-control
  • Порядок сортировки: по возрастанию или убыванию
  • Поле сортировки: имя текущего столбца сортировки
  • Множественная сортировка: конфигурация сортировки по нескольким столбцам
  • Скрытые столбцы: столбцы, скрытые пользователем вручную
  • Режим представления: карточное представление или обычное табличное представление