Giter VIP home page Giter VIP logo

react-telegram-web-app's Introduction

react-telegram-web-app

React components for Telegram WebApp

npm types GitHub Actions CI License

๐Ÿ”ด Live Demo & Code Examples

You can try open demo telegram bot with React WebApp @react_telegram_web_app_bot.

Also, you can look demo source code.

๐Ÿ”ง Installation & Get started

1๏ธโƒฃ Foremost, you have to do initializing web apps step, because package has dependency of Telegram Web App context.

2๏ธโƒฃ Install by running: npm i @vkruglikov/react-telegram-web-app --save. Today we support React^18.

3๏ธโƒฃ Try it out by writing code.

import React from 'react';
import { MainButton, useShowPopup } from '@vkruglikov/react-telegram-web-app';

const App = () => {
  const showPopup = useShowPopup();

  return (
    <>
      Some page content...
      <MainButton
        text="SHOW POPUP"
        onClick={() => {
          showPopup({
            message: "Hello, I'am showPopup handle",
          });
        }}
      />
    </>
  );
};

โœจ Short Documentation

  • MainButton - The component controls the main button, which is displayed at the bottom of the Web App in the Telegram interface.
  • BackButton - This component controls the back button, which can be displayed in the header of the Web App in the Telegram interface.
  • useShowPopup - The hook that provided showPopup function that shows a native popup.
  • useHapticFeedback - This hook that provided impactOccurred, notificationOccurred and selectionChanged functions that controls haptic feedback.
  • useThemeParams - This hook that provided colorScheme and themeParams object.
  • useScanQrPopup - This hook that provided showScanQrPopup and closeScanQrPopup functions.

๐Ÿ›ฃ Roadmap

Here's what's coming up:

  • In the future, We would like to use us components also in Web application, without Telegram context.
  • All Telegram WebApp feature support.
  • Main Telegram WebApp feature support.

๐Ÿฅ‚ License

MIT

react-telegram-web-app's People

Contributors

vkruglikov avatar github-actions[bot] avatar

Watchers

 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.