Описание конфигурации блока (файл .block.php)


У каждого шаблона блока есть свой файл конфигурации, в котором заданы его настройки. Все это хранится в файле .block.php в шаблоне компонента ranx:block.landing.

Внутри файла находится скрипт, который просто возвращает PHP-массив.

Ниже приведено описание каждого из возможных ключей этого массива.

_INCLUDE и _EXCLUDE

Эти ключи определяют то, какие настройки будут доступны в панели Контент и Дизайн.

По умолчанию, блок содержит следующие разделы:

  • CONTENT_TITLE - заголовок блока. Отображаются в панели Контент.
  • CONTENT_CARDS - карточки блока. Отображаются в панели Контент.
  • CONTENT_BTN - кнопки блока. Отображаются в панели Контент.
  • COLS - количество колонок в блоке. Отображается в панели Дизайн.
  • INDENTS - отступы сверху и снизу для блока. Отображается в панели Дизайн.
  • LINE_BOT - разделитель снизу. Отображается в панели Дизайн.
  • BG_COLOR - цвет фона. Отображается в панели Дизайн.
  • TEXT_COLOR - цвет текста (светлый или темный). Отображается в панели Дизайн.
  • BG_PICTURE - изображение для фона. Отображается в панели Дизайн.
  • PARALLAX_EFFECT - parallax-эффект для фона блока. Отображается в панели Дизайн.

Любой из этих разделов можно исключить через _EXCLUDE. Например, если ваш блок не предполагает использование карточек:

'_EXCLUDE' => ['CONTENT_CARDS']

Также можно добавить дополнительные разделы, аналогично через _INCLUDE:

  • ALIGN - выравнивание контента.
  • CONTENT_TABS - вкладки в блоках. Подробнее.
  • CONTENT_GALLERY_CARDS - альтернативное отображение карточек для галереи.
  • CONTENT_PREVIEW_PICTURE - картинка для анонса. Если нужна картинка для блока.
  • PICTURE_ALIGN - выравнивание картинки.
  • CONTENT_FORM - выбор формы для блока.
  • INDENT_ELEMENTS - отступы для карточек.
  • CONTENT_IMPORT - импорт карточек из внешнего инфоблока.
  • CONTENT_AUTO - если карточки могут отображать структуру раздела (см раздел Список в библиотеке блоков).
  • CONTENT_VIDEO - видео для блока.
  • CARDS_BG_COLOR - цвет фона для карточек.
  • HOVER_EFFECT - эффект при наведении на карточку.
  • TINT_COLOR - цвет тонировки.

NAME

Содержит название блока. Отображается в библиотеке блоков.

SETTINGS

Позволяет создавать свои настройки для блока. Например:

'SETTINGS' => [
    'AUTOPLAY' => [
        'TITLE' => 'Автоперелистывание слайдера',
        'TYPE' => 'checkbox',
        'DEFAULT' => false,
    ],
],

Доступные типы:

  • checkbox - галочка со значениями true или false.
  • select - выпадающий список. Значения указываются в ключе LIST.
  • text - текстовое поле textarea.
  • string - текстовое поле input.

ELEMENTS_FIELDS

Поля и свойства инфоблока "Элементы", которые будут доступны в карточке блока. Свойства указываются с префиксом PROPERTY_.

Кроме того, есть возможность использовать дополнительные ключи:

  • _BTN и _BTN2 - для вывода кнопок.
  • _LINK - ссылка.
  • _PRICE - цена (вместе со скидкой).
  • _SOCIALS - социальные сети.
  • _POPUP - модальное окно.

POPUP_ELEMENTS_FIELDS

Определяет какие поля пойдут в модальное окно.

FIELDS_MESS

Позволяет заменить названия полей для блока. Пример для замены названия поля "Заголовок" на "Имя":

'FIELDS_MESS' => [
    'NAME' => "Имя",
],

ELEMENTS_FIELDS_MESS

Аналогично предыдущему пункту, только для замены полей карточки. Для свойств нужен префикс PROPERTY_.

DEMO

Содержит в себе демо-контент для блока. Чтобы блок изначально не добавлялся пустым.

Включает в себя 2 ключа:

  • BLOCK - для информации о блоке. По сути, поля инфоблока "Блоки".
  • ELEMENTS - массив с карточками блока. По сути, поля инфоблока "Элементы".

Если свойство является списком, то необходимо указать XML_ID значения списка.

Если свойство является файлом, то необходимо указать название файла, а сам файл положить в папку demo в корне папки шаблона.

COLS и COLS_DEFAULT

Массив с возможным количеством колонок в блоке. Например: [2, 3, 4]. COLS_DEFAULT - значение по умолчанию.

INDENT_TOP_DEFAULT и INDENT_BOT_DEFAULT

Отступы по умолчанию сверху и снизу для блока.

ALIGN_DEFAULT

Выравнивание по умолчанию

IS_UNDER_HEADER

Может ли блок залезать под прозрачную шапку, если он находится в самом начале страницы. По умолчанию false.

USE_MAPS

Если true, то на странице с этим блоком будет подключен скрипт для карт.

CAN_SHOW_REGIONS и CAN_SHOW_BRANCHES

Если в настройках включен вывод регионов или филиалов в блоках, то вместо карточек будут данные о регионах или о филиалах.

MAX_CARDS_COUNT

Максимальное возможное количество карточек в блоке. По умолчанию, неограничено.