Установить обработчик готовности DOM-структуры BX24.ready

BX24.ready(handler: callable): void;

Метод BX24.ready добавляет функцию-обработчик, которая выполнится, когда DOM-структура документа будет готова: браузер разобрал страницу приложения, и ее элементы доступны для скрипта. По назначению метод похож на jQuery.ready.

Готовность страницы и готовность библиотеки — разные события. BX24.ready ждет только страницу приложения, а данные от Битрикс24 к этому моменту могут еще не прийти. Если обработчику нужны данные Битрикс24 или вызовы его методов, используйте BX24.init.

Метод работает на странице приложения, где подключена библиотека BX24.js, и не обращается к Битрикс24. Собственный scope методу не нужен.

Параметры методаПараметры метода

Обязательные параметры отмечены *

Пример кодаПример кода

Как использовать примеры в документации

<p id="status">Загрузка...</p>

<script>
    BX24.ready(function () {
        document.getElementById('status').textContent = 'Страница загружена';
    });
</script>

Обработка ответаОбработка ответа

Метод не возвращает данные (void). Если DOM-структура уже готова к моменту вызова, обработчик все равно выполнится не сразу, а после того, как закончится текущий код. Поэтому строки, которые идут после BX24.ready, выполнятся раньше обработчика.

Если библиотеку подключили из кода, а не тегом <script> в разметке, обработчик может выполниться позже — только когда загрузятся все картинки и стили страницы.

Обработка ошибокОбработка ошибок

Кодов ошибок метод не возвращает.

Продолжите изучениеПродолжите изучение

• Интерфейс, навигация и контекст: обзор методов
• Проверить готовность DOM-структуры BX24.isReady
• Инициализировать библиотеку BX24.init