@telegram-web-app/react v0.0.1-beta.1

@telegram-web-app/react

@telegram-web-app/core binding for react

Table of contents

• Installation
• Usage
• Components
  • TelegramWebAppProvider
• Hooks
  • useTelegramWebApp

Installation

@telegram-web-app/react required @telegram-web-app/core as a peer dependency, make sure to install it.

Using npm:

npm install @telegram-web-app/core @telegram-web-app/react

Usage

Import TelegramWebAppProvider from @telegram-web-app/react and wrap your app in it

import { TelegramWebAppProvider } from '@telegram-web-app/react';

...

<TelegramWebAppProvider>
  <App />
</TelegramWebAppProvider>

And then inside your app use useTelegramWebApp hook to get Telegram instance

import { useTelegramWebApp } from '@telegram-web-app/react';

export const App = () => {
  const telegram = useTelegramWebApp();
  ...
};

Components

TelegramWebAppProvider

React provider that exposes context to it's children components.

Props:

children

exposeInMainWorld

See @telegram-web-app/core docs

autoReady

Trigger or not automatically call Telegram.WebApp.ready() on app load. If you want manually call ready(), set this option to false.

Hooks

useTelegramWebApp

Returns ready to use Telegram instance, no additional options available.