Class Buttons

Buttons Класс для управления коллекцией кнопок и их отображением на различных платформах.

Класс предоставляет функциональность для:

Создания и управления коллекцией кнопок
Адаптации кнопок под различные платформы (Алиса, VK, Telegram, Viber, SmartApp)
Поддержки различных типов кнопок (интерактивные, ссылки)

Example

// Создание коллекции кнопок
const buttons = new Buttons();

// Добавление интерактивной кнопки
buttons.addBtn('Нажми меня', '', { action: 'custom_action' });

// Добавление кнопки-ссылки с полным набором параметров
buttons.addLink('Перейти на сайт', 'https://example.com', { source: 'button' }, { hide: true });

// Получение кнопок для конкретной платформы
const alisaButtons = buttons.getButtons(Buttons.T_ALISA_BUTTONS);

Index

Constructors

constructor

new Buttons(): Buttons
Создает новый экземпляр коллекции кнопок. Инициализирует все массивы и устанавливает тип кнопок по умолчанию для Алисы.

Returns Buttons
- Defined in src/components/button/Buttons.ts:123

Properties

`Static` `Readonly`T_ALISA_BUTTONS

T_ALISA_BUTTONS: "alisa_btn" = 'alisa_btn'

Кнопки для Алисы.

`Static` `Readonly`T_ALISA_CARD_BUTTON

T_ALISA_CARD_BUTTON: "alisa_card_btn" = 'alisa_card_btn'

Кнопки для карточки Алисе.

`Static` `Readonly`T_VK_BUTTONS

T_VK_BUTTONS: "vk_btn" = 'vk_btn'

Кнопки для vk.

`Static` `Readonly`T_TELEGRAM_BUTTONS

T_TELEGRAM_BUTTONS: "telegram_btn" = 'telegram_btn'

Кнопки для Telegram.

`Static` `Readonly`T_VIBER_BUTTONS

T_VIBER_BUTTONS: "viber_btn" = 'viber_btn'

Кнопки для viber.

`Static` `Readonly`T_SMARTAPP_BUTTONS

T_SMARTAPP_BUTTONS: "smart-app_btn" = 'smart-app_btn'

Кнопки для Сбер SmartApp.

`Static` `Readonly`T_SMARTAPP_BUTTON_CARD

T_SMARTAPP_BUTTON_CARD: "smart-app_card_btn" = 'smart-app_card_btn'

Кнопки для карточки Сбер SmartApp.

`Static` `Readonly`T_USER_APP_BUTTONS

T_USER_APP_BUTTONS: "user_app_btn" = 'user_app_btn'

Кнопки для пользовательского типа приложения.

buttons

buttons: Button[]

Массив объектов Button, представляющих все кнопки в коллекции.

See

Button

btns

btns: TButton[]

Массив интерактивных кнопок. Может содержать строки или объекты с параметрами кнопки.

links

links: TButton[]

Массив кнопок-ссылок. Может содержать строки или объекты с параметрами кнопки.

type

type: string

Тип кнопок для текущей платформы. Определяет, как будут отображаться кнопки.

Methods

clear

clear(): void
Очищает все массивы кнопок.

Returns void
- Defined in src/components/button/Buttons.ts:134

`Protected`_add

_add(
    title: null | string,
    url: null | string,
    payload: any,
    hide?: boolean,
    options?: IButtonOptions,
): Buttons
Protected
Добавляет кнопку в коллекцию.
Parameters
- title: null | string
  Текст кнопки
- url: null | string
  URL для перехода
- payload: any
  Дополнительные данные
- hide: boolean = false
  Тип отображения кнопки
- options: IButtonOptions = {}
  Дополнительные параметры
Returns Buttons
this для цепочки вызовов
- Defined in src/components/button/Buttons.ts:151

addBtn

addBtn(
    title: null | string,
    url?: null | string,
    payload?: any,
    options?: IButtonOptions,
): Buttons
Добавляет интерактивную кнопку в коллекцию.
Parameters
- title: null | string
  Текст кнопки
- Optionalurl: null | string = ''
  URL для перехода
- Optionalpayload: any = ''
  Дополнительные данные
- Optionaloptions: IButtonOptions = {}
  Дополнительные параметры
Returns Buttons
this для цепочки вызовов
Example
```
// Простая кнопка
buttons.addBtn('Нажми меня');

// Кнопка с URL и payload
buttons.addBtn('Перейти', 'https://example.com', { action: 'navigate' });

// Кнопка с дополнительными опциями
buttons.addBtn('Скрытая кнопка', '', '', { hide: true });
```
- Defined in src/components/button/Buttons.ts:195

addLink

addLink(
    title: null | string,
    url?: string,
    payload?: any,
    options?: IButtonOptions,
): Buttons
Добавляет кнопку-ссылку в коллекцию.
Parameters
- title: null | string
  Текст кнопки
- Optionalurl: string = ''
  URL для перехода
- Optionalpayload: any = ''
  Дополнительные данные
- Optionaloptions: IButtonOptions = {}
  Дополнительные параметры
Returns Buttons
this для цепочки вызовов
Example
```
// Простая ссылка
buttons.addLink('Перейти на сайт', 'https://example.com');

// Ссылка с payload
buttons.addLink('Документация', 'https://docs.example.com', { section: 'api' });

// Ссылка с опциями
buttons.addLink('Скрытая ссылка', 'https://example.com', '', { hide: true });
```
- Defined in src/components/button/Buttons.ts:225

`Protected`_processing

_processing(): void
Protected
Обрабатывает массивы btns и links, добавляя их в основной массив buttons. После обработки очищает массивы btns и links.

Returns void
- Defined in src/components/button/Buttons.ts:265

getButtons

getButtons<T = any>(
type?: null | string,
userButton?: null | TemplateButtonTypes,
): null | T

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

Type Parameters

T = any

Parameters

Optionaltype: null | string = null
Тип кнопок (платформа). Если не указан, используется текущий тип. Доступные типы:
- T_ALISA_BUTTONS: кнопки для Алисы
- T_ALISA_CARD_BUTTON: кнопки для карточки Алисы
- T_VK_BUTTONS: кнопки для VK
- T_TELEGRAM_BUTTONS: кнопки для Telegram
- T_VIBER_BUTTONS: кнопки для Viber
- T_SMARTAPP_BUTTONS: кнопки для Сбер SmartApp
- T_SMARTAPP_BUTTON_CARD: кнопки для карточки SmartApp
- T_USER_APP_BUTTONS: кнопки для пользовательского приложения
OptionaluserButton: null | TemplateButtonTypes = null
Пользовательский класс кнопок для T_USER_APP_BUTTONS

Returns null | T

Адаптированные кнопки для платформы или null, если тип не поддерживается

Example

const buttons = new Buttons();

// Добавление кнопок
buttons.addBtn('Нажми меня', '', { action: 'test' });
buttons.addLink('Сайт', 'https://example.com');

// Получение кнопок для разных платформ

// Алиса
const alisaButtons = buttons.getButtons(Buttons.T_ALISA_BUTTONS);
// alisaButtons: [
//   { title: 'Нажми меня', payload: { action: 'test' }, hide: true },
//   { title: 'Сайт', url: 'https://example.com', hide: false }
// ]

// VK
const vkButtons = buttons.getButtons(Buttons.T_VK_BUTTONS);
// vkButtons: {
//   one_time: true,
//   buttons: [
//     { action: { type: 'text', label: 'Нажми меня', payload: { action: 'test' } } },
//     { action: { type: 'link', label: 'Сайт', link: 'https://example.com' } }
//   ]
// }

// Telegram
const telegramButtons = buttons.getButtons(Buttons.T_TELEGRAM_BUTTONS);
// telegramButtons: {
//   inline_keyboard: [
//     [{ text: 'Нажми меня', callback_data: { action: 'test' } }],
//     [{ text: 'Сайт', url: 'https://example.com' }]
//   ]
// }

// Viber
const viberButtons = buttons.getButtons(Buttons.T_VIBER_BUTTONS);
// viberButtons: {
//   DefaultHeight: true,
//   BgColor: '#FFFFFF',
//   Buttons: [
//     { Text: 'Нажми меня', ActionType: 'reply', ActionBody: { action: 'test' } },
//     { Text: 'Сайт', ActionType: 'open-url', ActionBody: 'https://example.com' }
//   ]
// }

getButtonJson

getButtonJson(
type?: null | string,
userButton?: null | TemplateButtonTypes,
): null | string
Возвращает JSON-представление кнопок для указанной платформы.
Parameters
- Optionaltype: null | string = null
  Тип кнопок (платформа)
- OptionaluserButton: null | TemplateButtonTypes = null
  Пользовательский класс кнопок
Returns null | string
JSON-строка с кнопками
Example
```
// Получение JSON для кнопок Алисы
const alisaButtonsJson = buttons.getButtonJson(Buttons.T_ALISA_BUTTONS);
```
- Defined in src/components/button/Buttons.ts:408

Class Buttons

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Buttons

Properties

Static ReadonlyT_ALISA_BUTTONS

Static ReadonlyT_ALISA_CARD_BUTTON

Static ReadonlyT_VK_BUTTONS

Static ReadonlyT_TELEGRAM_BUTTONS

Static ReadonlyT_VIBER_BUTTONS

Static ReadonlyT_SMARTAPP_BUTTONS

Static ReadonlyT_SMARTAPP_BUTTON_CARD

Static ReadonlyT_USER_APP_BUTTONS

buttons

See

btns

links

type

Methods

clear

Returns void

Protected_add

Parameters

Returns Buttons

addBtn

Parameters

Returns Buttons

Example

addLink

Parameters

Returns Buttons

Example

Protected_processing

Returns void

getButtons

Type Parameters

Parameters

Returns null | T

Example

getButtonJson

Parameters

Returns null | string

Example

Settings

On This Page

`Static` `Readonly`T_ALISA_BUTTONS

`Static` `Readonly`T_ALISA_CARD_BUTTON

`Static` `Readonly`T_VK_BUTTONS

`Static` `Readonly`T_TELEGRAM_BUTTONS

`Static` `Readonly`T_VIBER_BUTTONS

`Static` `Readonly`T_SMARTAPP_BUTTONS

`Static` `Readonly`T_SMARTAPP_BUTTON_CARD

`Static` `Readonly`T_USER_APP_BUTTONS

`Protected`_add

`Protected`_processing