Extension — JS-расширения

Пространство имен: Bitrix\Main\UI

Модуль: main — подключать отдельно не нужно

Когда использовать

Класс Extension подключает JS-расширения на страницу. Метод load регистрирует расширение и подключает его файлы вместе с зависимостями. Все методы класса статические.

Имя расширения состоит из частей через точку, например main.loader или vendor.module.widget. Расширение лежит в каталоге /local/js/<части имени>/ или /bitrix/js/<части имени>/, его описывает файл config.php. Класс ищет каталог сначала в /local/, затем в /bitrix/.

Класс не находит по файлам расширения ядра без точки в имени, например popup. Их регистрирует CJSCore при первом вызове CJSCore::Init. До этого Extension::load('popup') пропустит расширение.

Аналог в классическом API — метод CJSCore::Init. Метод load вызывает его после регистрации расширения.

Подробнее — в статье Расширения.

Методы класса

Методы делятся на две группы по назначению.

Подключение

Метод Описание С версии
load Подключает одно или несколько расширений на страницу
register Регистрирует расширение по файлу config.php без подключения
registerAssets Регистрирует расширение по готовой конфигурации
getHtml Регистрирует расширение и возвращает HTML-код для его подключения

Конфигурация и зависимости

Метод Описание С версии
getConfig Возвращает конфигурацию расширения из config.php
getBundleConfig Возвращает пространство имен JS из bundle.config.js или bundle.config.ts
getAssets Возвращает JS- и CSS-файлы расширения и зависимостей
getDependencyList Возвращает зависимости расширения
getResourceList Возвращает все ресурсы расширений для подключения

Смотрите также