Skip to content

@telegram-apps/sdk

从零开始制作的 TypeScript 库,用于与 Telegram 迷你应用程序 功能无缝通信。

该库的代码旨在简化开发人员与 Telegram 迷你应用程序交互的过程。 它由多个独立组件组成,每个组件负责 Telegram 迷你应用程序生态系统的特定 方面。

在开始使用 SDK 之前,我们强烈建议您先熟悉 Telegram Mini Apps 文档 以掌握平台的基本概念。

安装

bash
pnpm i @telegram-apps/sdk
bash
npm i @telegram-apps/sdk
bash
yarn add @telegram-apps/sdk

先决条件

在深入了解本软件包的文档之前,建议 先熟悉以下软件包:

  • @telegram-apps/signals - 我们自己的 JavaScript 信号,在软件包中几乎随处可见 。
  • @telegram-apps/bridge - 与 Telegram 迷你应用程序的最底层通信层。 SDK 在引擎盖下使用它,并重新导出一些功能。

使用示例

ts
import { init, backButton } from '@telegram-apps/sdk';

// Init the package and actualize all global dependencies.
init();

// Mount the back button component and retrieve its actual
// state.
backButton.mount();

// When a user clicked the back button, go back in the
// navigation history.
const off = backButton.onClick(() => {
  off();
  window.history.back();
});

Released under the MIT License.