Класс Tab

Класс представляет вкладку диалога.

Конструктор

__construct(array $options)

Создает объект класса Tab.

$options — массив опций элемента. Определяется структурой TabOptions:

id: string
Идентификатор вкладки. Обязательная опция.

title: string | TextNodeOptions
Заголовок вкладки. Определяется либо строкой, либо структурой TextNodeOptions.

icon
Иконка вкладки. Указывается либо путь к изображению, либо файл в формате Data URL.
Значение задается либо сразу для всех состояний ярлыка вкладки, либо отдельно для каждого состояния согласно структуре TabLabelStates.

textColor
Цвет текста заголовка вкладки.
Значение задается либо сразу для всех состояний ярлыка вкладки, либо отдельно для каждого состояния согласно структуре TabLabelStates.

bgColor
Фон заголовка вкладки.
Значение задается либо сразу для всех состояний ярлыка вкладки, либо отдельно для каждого состояния согласно структуре TabLabelStates.

visible: bool
Видимость вкладки.
Если задано значение false, вкладка считается невидимой, для нее не отображается заголовок в виде ярлыка сбоку диалога. По умолчанию true.

itemOrder: array
Сортировка элементов на вкладке. Задается массивом, структура которого совпадает с типом ItemNodeOrder.

itemMaxDepth: number
Максимальный уровень вложенности элементов, который отображается визуальным сдвигом. По умолчанию 5.

stub: boolean | string
Определяет "заглушку" пустого списка вкладки. По умолчанию true — выводится стандартная заглушка. Также можно указать полное название класса в виде строки.

stubOptions: array
Дополнительные опции заглушки. Задаются массивом. Для стандартной заглушки (stub: true) доступны следующие настройки.

footer: string
Определяет футер вкладки. Задается либо верстка, либо полное название класса футера.

footerOptions
Дополнительные опции футера. Передаются в конструктор класса футера.

showDefaultFooter?: boolean
Определяет нужно ли показывать футер диалога. По умолчанию true.

showAvatars
Отображать аватары элементов. По умолчанию значение не задано.

Методы

Метод	Описание	С версии
getId(): ?string	Возвращает идентификатор вкладки.
getTitle(): string	Возвращает заголовок вкладки.
setTitle($title): self	Устанавливает заголовок вкладки. Заголовок определяется либо строкой, либо структурой TextNodeOptions.
setIcon(array $icon): self	Устанавливает иконку вкладки либо для всех состояний ярлыка, либо отдельно для каждого состояния согласно структуре TabLabelStates.
setTextColor(array $textColor): self	Устанавливает цвет текста заголовка вкладки либо для всех состояний ярлыка, либо отдельно для каждого состояния согласно структуре TabLabelStates.
setBgColor(array $bgColor): self	Устанавливает цвет фона заголовка вкладки либо для всех состояний ярлыка, либо отдельно для каждого состояния согласно структуре TabLabelStates.
setVisible(bool $flag): self	Устанавливает видимость вкладки.
isVisible()	Возвращает `true`, если вкладка видима в диалоге (отображается заголовок в виде ярлыка сбоку диалога).
setItemOrder(array $order): self	Устанавливает сортировку элементов на вкладке. Задается массивом, структура которого совпадает с типом ItemNodeOrder.
setItemMaxDepth(int $depth): self	Устанавливает максимальный уровень вложенности элементов, который отображается визуальным сдвигом.
getItemMaxDepth(): ?int	Возвращает максимальный уровень вложенности элементов, который отображается визуальным сдвигом.
setStub(bool\|string $stub): self	Устанавливает "заглушку" пустого списка вкладки. По умолчанию `true` — выводится стандартная заглушка. Также можно указать полное название класса в виде строки.
setStubOptions(array $options): self	Устанавливает опции заглушке.
setFooter(string $footer, array $options = []): self	Устанавливает или удаляет футер вкладки
enableDefaultFooter(): self	Включает отображение футера диалога.
disableDefaultFooter(): self	Выключает отображение футера диалога.
setShowAvatars(bool $flag): self	Включает или отключает показ аватаров во вкладке.

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх