弹出窗口

负责 Telegram 小程序 popup 的💠组件。

检查支持

要检查当前 Telegram 小程序版本是否支持弹出窗口，需要使用 isSupported 方法：

Variable

import { popup } from '@telegram-apps/sdk';

popup.isSupported(); // boolean

Functions

import { isPopupSupported } from '@telegram-apps/sdk';

isPopupSupported(); // boolean

打开

要打开弹出窗口，需要调用 open 方法，指定弹出窗口的属性：标题、 信息和最多 3 个按钮的列表。

该方法返回一个 Promise，当按钮被点击时，该 Promise 会被解析为点击的按钮标识符。 在 此情况下，如果用户没有点击任何按钮，该方法将返回 null。

调用该方法会更新 isOpened 信号属性值。

Variable

import { popup } from '@telegram-apps/sdk';

if (popup.open.isAvailable()) {
  // popup.isOpened() -> false
  const promise = popup.open({
    title: 'Hello!',
    message: 'Here is a test message.',
    buttons: [{ id: 'my-id', type: 'default', text: 'Default text' }],
  });
  // popup.isOpened() -> true
  const buttonId = await promise;
  // popup.isOpened() -> false
}

Functions

import { openPopup, isPopupOpened } from '@telegram-apps/sdk';

if (openPopup.isAvailable()) {
  // isPopupOpened() -> false
  const promise = openPopup({
    title: 'Hello!',
    message: 'Here is a test message.',
    buttons: [{ id: 'my-id', type: 'default', text: 'Default text' }],
  });
  // isPopupOpened() -> true
  const buttonId = await promise;
  // isPopupOpened() -> false
}