Skip to content

AlexIvFreeworld/ialex.cookies

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ialex.cookies

Модуль для вывода уведомления об использовании cookie в публичной части сайта на Bitrix.

Что делает модуль

  • Показывает баннер только в публичной части сайта.
  • Не показывает баннер в административном разделе.
  • Не показывает баннер, если у посетителя уже установлена cookie cookie_consent=accepted.
  • Подключает фронтенд-ассеты через CJSCore.
  • Использует опубликованные файлы: /bitrix/js/ialex.cookies/cookies.js /bitrix/css/ialex.cookies/cookies.css
  • Позволяет настраивать внешний вид и тексты через стандартную страницу настроек модуля.

Установка и обновление

  1. Установить или обновить модуль через административный раздел Bitrix.
  2. При установке или обновлении модуль копирует ассеты: /bitrix/modules/ialex.cookies/install/js/* -> /bitrix/js/ialex.cookies/ /bitrix/modules/ialex.cookies/install/css/* -> /bitrix/css/ialex.cookies/
  3. После обновления рекомендуется очистить кеш Bitrix, если изменения не появились сразу.

Как работает модуль

  • На событии main:OnBeforeProlog вызывается обработчик IAlex\Cookies::init().
  • Если модуль включен и баннер нужно показать, модуль подключает JS/CSS через CJSCore.
  • Если модуль включен и баннер нужно показать, модуль добавляет на страницу JSON-конфиг с настройками баннера.
  • Баннер создается в браузере после DOMContentLoaded из файла cookies.js.

Настройки модуля

Доступны следующие параметры:

  • Показывать уведомление
  • Тип позиционирования блока
  • Отступ снизу
  • Отступ слева
  • Отступ справа
  • Цвет фона
  • Цвет текста
  • Внутренние отступы
  • Радиус скругления углов
  • Выравнивание текста
  • Слой отображения (z-index)
  • Текст уведомления
  • Ссылка на страницу с описанием cookies
  • Текст ссылки
  • Текст кнопки

Особенности значений

  • Внутренние отступы задаются числом без px.
  • Пример значения Внутренние отступы: 15
  • Радиус скругления углов можно задавать числом.
  • Пример значения Радиус скругления углов: 12
  • Для отступов слева, справа и снизу можно использовать число или CSS-значение.
  • Примеры значений: 0, 20, 2rem
  • Цвета задаются как CSS-значения.
  • Примеры значений: #333333, #ffffff, rgba(0,0,0,0.8)

Основные файлы

  • install/index.php — установка, удаление, регистрация событий и копирование файлов
  • include.php — регистрация CJSCore-расширения и автозагрузка класса
  • classes/general/IAlexCookies.php — серверная логика модуля
  • options.php — страница настроек в админке
  • default_option.php — значения по умолчанию
  • install/js/cookies.js — логика показа баннера
  • install/css/cookies.css — стили баннера

Cookie

Модуль использует cookie:

  • cookie_consent=accepted

Срок хранения — 1 год.

Заметки для разработки

  • После любого изменения файлов из install/js или install/css модуль нужно обновить через админку, чтобы Bitrix заново скопировал ассеты в /bitrix/js/ialex.cookies и /bitrix/css/ialex.cookies.
  • При изменении структуры настроек стоит повышать версию модуля в install/version.php.
  • Если баннер не появляется, сначала стоит проверить, включен ли модуль.
  • Если баннер не появляется, сначала стоит проверить, нет ли уже cookie cookie_consent.
  • Если баннер не появляется, сначала стоит проверить, подключаются ли /bitrix/js/ialex.cookies/cookies.js и /bitrix/css/ialex.cookies/cookies.css.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors