Документация для разработчиков
Темная тема

Класс BaseStub

Базовый абстрактный класс заглушки вкладки.

Конструктор

constructor(tab: Tab, options: { [option: string]: any })

Конструктор класса. В классах-наследниках необходимо вызвать этот конструктор следующим образом:

super(tab, options);

  • tab: Tab — объект вкладки, для которого будет создана заглушка.
  • options — дополнительные опции заглушки.
    • autoShow:boolean — автоматически показывать заглушку при выборе вкладки с пустым списком элементов. По умолчанию true.

Методы

Метод Описание С версии
render(): HTMLElement Абстрактный метод, который должен вернуть верстку заглушки. Обязательна реализация метода в классах-наследниках.
getTab(): Tab Возвращает объект вкладки, для которого создана заглушка.
isAutoShow(): boolean Возвращает true, если заглушка показывается автоматически при выборе вкладки с пустым списком элементов.
show(): void Показывает заглушку.
hide(): void Скрывает заглушку.
getOptions(): { [option: string]: any } Возвращает коллекцию произвольных опций заглушки.
getOption(option: string, defaultValue?: any): any Возвращает значение опции с названием option. Если опция не найдена, вернет значение, указанное в defaultValue. Если defaultValue не указан, вернет null.

Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх