Code Monkey home page Code Monkey logo

react-telegram-webapp's Introduction

React context for Telegram WebApp

This library can be used to create React UIs in use with the new Telegram WebApp feature. This library use context to feed all your components with the current state of the Telegram props.

Usage (with Component)

Wrap your components with a TelegramWebApp component. It receives a validateHash function, which will be called to validate the hash received from Telegram.

import React from 'react';
import ReactDOM from 'react-dom';
import { TelegramWebApp } from 'react-telegram-webapp';

async function validateHash(hash) {
    const response = await fetch(`/api/validate`, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
        },
        body: JSON.stringify({ hash }),
    });
    
    return response.ok;
}

ReactDOM.render(
  <TelegramWebApp validateHash={validateHash}>
    <MyComponent />
  </TelegramWebApp>,
  document.getElementById('root')
);

Usage (with wrapper function)

You can also wrap your components with a withTelegramWebApp function. It also receives a validateHash function, which will be called to validate the hash received from Telegram.

import React from 'react';
import { withTelegramWebApp } from 'react-telegram-webapp';

function App() {
  return <MyComponent />;
}

async function validateHash(hash) {
    const response = await fetch(`/api/validate`, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
        },
        body: JSON.stringify({ hash }),
    });

    return response.ok;
}

export default withTelegramWebApp(App, {
    validateHash
});

Useful hooks

useStartParam - return the start params useTelegramWebApp - return the TelegramWebApp object useIsTelegramWebAppReady - returns true if the TelegramWebApp is ready. You can use this to show loading screen

Contribute

If you want to contribute to this library, please open an issue or pull request.

react-telegram-webapp's People

Contributors

davidsl4 avatar j053fabi0 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.