umbot
    Preparing search index...

    Interface IVkButton

    IVkButton Интерфейс для кнопки VK.

    Определяет структуру кнопки и её визуальное представление.

    const button: IVkButton = {
        action: {
            type: 'text',
            label: 'Нажми меня',
            payload: { action: 'click' }
        },
        color: 'primary'
    };
    interface IVkButton {
        _group?: string;
        action: IVkButtonAction;
        color?: string;
        hash?: string | null;
        payload?: Record<string, unknown>;
    }
    Index

    Properties

    _group? action color? hash? payload?

    Properties

    Optional_group

    _group?: string

    Значение группы из button.options._group, по которому адаптер группирует кнопки в ряды: все кнопки с одинаковой группой попадают в одну строку клавиатуры. Из результирующей VK-кнопки поле удаляется.

    const button: IVkButton = {
        action: { type: 'text', label: 'Нажми меня' },
        _group: '1'
    };
    action: IVkButtonAction

    Действие кнопки. Определяет тип действия и его параметры.

    const button: IVkButton = {
        action: {
            type: 'text',
            label: 'Нажми меня'
        }
    };
    color?: string

    Цвет кнопки. Возможные значения:

    • primary - основная кнопка (синяя)
    • secondary - вторичная кнопка (белая)
    • negative - отрицательная кнопка (красная)
    • positive - положительная кнопка (зеленая)
    const button: IVkButton = {
        action: { type: 'text', label: 'Нажми меня' },
        color: 'primary'
    };
    hash?: string | null

    Хеш кнопки.

    VK API принимает hash только внутри action (см. IVkButtonAction.hash). Поле оставлено для обратной совместимости типов, фреймворк его больше не заполняет.

    const button: IVkButton = {
        action: { type: 'vkpay', hash: 'abc123' }
    };
    payload?: Record<string, unknown>

    Не используется: VK принимает payload только внутри action (см. IVkButtonAction.payload); фреймворк это поле не заполняет. Поле планируется убрать из интерфейса (в VK API его нет).

    Settings

    Member Visibility

    On This Page

    Properties