Описание
Этот объект управляет кнопкой, которая отображается в нижней части Mini App в интерфейсе Telegram.
| Поле | Тип | Описание |
|---|---|---|
| type | String | Только для чтения. Тип кнопки. Может быть либо main для главной кнопки, либо secondary для второстепенной кнопки. |
| iconCustomEmojiId | String | Bot API 9.5+ Уникальный идентификатор пользовательского эмодзи, отображаемого перед текстом кнопки. |
| text | String | Текущий текст кнопки. По умолчанию установлено значение Continue для главной кнопки и Cancel для второстепенной кнопки. |
| color | String | Текущий цвет кнопки. По умолчанию установлено значение themeParams.button_color для главной кнопки и themeParams.bottom_bar_bg_color для второстепенной кнопки. |
| textColor | String | Текущий цвет текста кнопки. По умолчанию установлено значение themeParams.button_text_color для главной кнопки и themeParams.button_color для второстепенной кнопки. |
| isVisible | Boolean | Показывает, видна ли кнопка. По умолчанию установлено значение false. |
| isActive | Boolean | Показывает, активна ли кнопка. По умолчанию установлено значение true. |
| hasShineEffect | Boolean | Bot API 7.10+ Показывает, имеет ли кнопка эффект свечения. По умолчанию установлено значение false. |
| position | String | Bot API 7.10+ Позиция второстепенной кнопки. Не определено для главной кнопки. Применяется только если видны обе кнопки (главная и второстепенная). По умолчанию установлено значение left. Поддерживаемые значения: - left, отображается слева от главной кнопки, - right, отображается справа от главной кнопки, - top, отображается над главной кнопкой, - bottom, отображается под главной кнопкой. |
| isProgressVisible | Boolean | Только для чтения. Показывает, отображается ли на кнопке индикатор загрузки. |
| setText(text) | Function | Метод для установки текста кнопки. |
| onClick(callback) | Function | Метод, который устанавливает обработчик события нажатия на кнопку. Псевдоним для Telegram.WebApp.onEvent('mainButtonClicked', callback) |
| offClick(callback) | Function | Метод, который удаляет обработчик события нажатия на кнопку. Псевдоним для Telegram.WebApp.offEvent('mainButtonClicked', callback) |
| show() | Function | Метод для отображения кнопки. Обратите внимание, что открытие Mini App из меню вложений скрывает главную кнопку до тех пор, пока пользователь не взаимодействует с интерфейсом Mini App. |
| hide() | Function | Метод для скрытия кнопки. |
| enable() | Function | Метод для включения кнопки. |
| disable() | Function | Метод для отключения кнопки. |
| showProgress(leaveActive) | Function | Метод для отображения индикатора загрузки на кнопке. Рекомендуется показывать индикатор загрузки, если действие, связанное с кнопкой, может занять много времени. По умолчанию кнопка отключается на время выполнения действия. Если передан параметр leaveActive=true, кнопка остается включенной. |
| hideProgress() | Function | Метод для скрытия индикатора загрузки. |
| setParams(params) | Function | Метод для установки параметров кнопки. Параметр params — это объект, содержащий одно или несколько полей, которые необходимо изменить: icon_custom_emoji_id - Bot API 9.5+ идентификатор эмодзи иконки кнопки; text - текст кнопки; color - цвет кнопки; text_color - цвет текста кнопки; has_shine_effect - Bot API 7.10+ включить эффект свечения; position - позиция второстепенной кнопки; is_active - включить кнопку; is_visible - показать кнопку. |
Все эти методы возвращают объект BottomButton, поэтому их можно объединять в цепочки.
История изменений
- API 9.5. Обновлен объект BottomButton: Добавлено поле iconCustomEmojiId