Чек-лист к материалу

Превратите таблицу в статье, инструкции или гайде в личный чек-лист читателя. Пункты остаются на своём месте в тексте, а посетитель отмечает выполненные шаги и видит свой прогресс.

Чек-лист прямо в материале

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

• Чекбоксы у строк, счётчик выполненных пунктов, процент и шкала прогресса.
• Переключение нажатием на чекбокс или строку; ссылки внутри строки остаются ссылками.
• Быстрый отклик: галочка и счётчик меняются сразу, операции сохраняются в фоне по очереди.
• Понятный статус сохранения; при ошибке неподтверждённые изменения откатываются.
• Личный сброс отметок с подтверждением.

Каждый читатель проходит список для себя

Регистрация необязательна. Гостевые отметки хранятся в текущем браузере: по умолчанию три дня после последнего изменения. Просмотр страницы срок не продлевает. У авторизованного пользователя отдельный прогресс сохраняется в базе и доступен при входе в тот же аккаунт. Гостевые отметки автоматически в аккаунт не переносятся.

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

В админке меняются шаблон счётчика, сообщение для гостя, срок хранения от 1 до 365 дней и подпись кнопки сброса. Компонент автоматически назначает постоянные ID таблицам и пунктам, поэтому изменение текста и перестановка строк с сохранением их атрибутов не сбрасывают идентичность пунктов.

Оформление наследует цвета сайта, поддерживает светлую и тёмную темы и мобильные экраны. Дополнительное поле «Чек-лист к материалу» также входит в комплект, но для готовой таблицы в тексте оно не требуется.

Что нового в версии 1.0.1

• Мгновенный отклик. Галочка, выделение строки, счётчик и шкала меняются сразу после нажатия, без ожидания ответа сервера.
• Быстрые последовательные отметки. Список больше не блокируется на время сохранения. Клики обрабатываются фоновой очередью в правильном порядке, включая повторное нажатие одного пункта.
• Меньше запросов. Для сохранения отметки пользователя используется один запрос вместо двух. Проверки аккаунта, CSRF и доступа сохранены.
• Обработка ошибок. Статус «Сохраняем…» показывается до подтверждения. При ошибке откатываются неподтверждённые действия, а уже сохранённые отметки остаются.
• Очередь при переключении вкладок. Начатое сохранение продолжается в фоне; при возвращении состояние перечитывается.
• Поддержка Redactor. В пакет добавлен необязательный плагин articlechecklistattrs: включите его в отдельной копии пресета редактора, чтобы сохранять постоянные ID таблицы и пунктов.
• Новая подробная инструкция. Добавлены разделы по установке, обновлению, настройке HTML-фильтра и редактора, а также проверке сохранения прогресса.

Обновление с версии 1.0.0 сохраняет настройки компонента, таблицы, постоянные ID и личный прогресс читателей.

Условия работы

Проверено на InstantCMS 2.18.2; требуется PHP 8.2 или новее с DOM. Поддерживаются опубликованные общедоступные материалы без родительской группы и плоские таблицы до 500 пунктов. Вложенные таблицы пропускаются. Перед подключением нужно разрешить служебные атрибуты в копии штатного HTML-пресета поля и настроить редактор на их сохранение. Установщик не меняет общие пресеты автоматически.