umbot - v2.0.8
    Preparing search index...

    Interface IButton

    IButton Интерфейс для определения структуры кнопки.

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

    // Создание простой текстовой кнопки
    const button: IButton = {
        title: 'Нажми меня',
        payload: { action: 'click' }
    };

    // Создание кнопки-ссылки
    const linkButton: IButton = {
        title: 'Перейти на сайт',
        url: 'https://example.com',
        options: { color: 'primary' }
    };

    // Создание кнопки с контактом (Telegram)
    const contactButton: IButton = {
        title: 'Отправить контакт',
        options: { request_contact: true }
    };

    // Создание кнопки с локацией (Telegram)
    const locationButton: IButton = {
        title: 'Отправить локацию',
        options: { request_location: true }
    };
    interface IButton {
        title?: string;
        text?: string;
        url?: string;
        payload?: any;
        options?: IButtonOptions;
    }
    Index

    Properties

    title? text? url? payload? options?

    Properties

    title?: string

    Заголовок кнопки. Основной текст, отображаемый на кнопке. Используется на всех платформах.

    const button: IButton = {
        title: 'Нажми меня'
    };

    Optionaltext

    text?: string

    Альтернативный текст кнопки. Используется в некоторых платформах вместо title. Например, в VK API используется text вместо title.

    const button: IButton = {
        text: 'Нажми меня'
    };
    url?: string

    URL для перехода при нажатии на кнопку. Используется для кнопок-ссылок. Поддерживается на всех платформах.

    const button: IButton = {
        title: 'Перейти на сайт',
        url: 'https://example.com'
    };
    payload?: any

    Дополнительные данные, передаваемые при нажатии на кнопку. Могут содержать любую информацию, необходимую для обработки нажатия. Используется для передачи контекста или параметров действия.

    // Простой payload
    const button: IButton = {
        title: 'Добавить в корзину',
        payload: {
            action: 'add_to_cart',
            productId: 123
        }
    };

    // Сложный payload с метаданными
    const button: IButton = {
        title: 'Оформить заказ',
        payload: {
            action: 'checkout',
            orderId: 456,
            metadata: {
                source: 'cart',
                timestamp: Date.now(),
                userPreferences: {
                    delivery: 'express',
                    payment: 'card'
                }
            }
        }
    };
    options?: IButtonOptions

    Дополнительные параметры кнопки. Влияют на внешний вид и поведение кнопки. Могут включать как общие, так и платформо-специфичные настройки.

    // Общие настройки
    const button: IButton = {
        title: 'Нажми меня',
        options: {
            color: 'primary',
            size: 'large'
        }
    };

    // Платформо-специфичные настройки
    const button: IButton = {
        title: 'Отправить контакт',
        options: {
            request_contact: true,
            color: 'primary',
            size: 'large'
        }
    };

    Settings

    Member Visibility

    On This Page

    Properties