Telegram Mini Apps NPM Package 📦

A powerful and feature-rich TypeScript-based NPM package for interacting with Telegram Mini Apps. This package provides a seamless way to integrate Telegram Mini Apps into your projects, offering a wide range of functionalities to enhance user experience. 🚀

---

Features ✨

• Core Methods: Ready, expand, close, and more. 🛠️
• UI Controls: BackButton, MainButton, SettingsButton. 🎛️
• Haptic Feedback: Provide tactile feedback to users. 📳
• Cloud Storage: Store and retrieve user-specific data. ☁️
• Biometric Authentication: Integrate fingerprint and face recognition. 🔒
• Location Manager: Access device location. 🌍
• Sensors: Accelerometer, Gyroscope, and Device Orientation. 📡
• QR Scanner: Scan QR codes directly in the app. 📷
• Clipboard: Read text from the clipboard. 📋
• Sharing: Share media to stories and messages. 📤
• Fullscreen Mode: Enter and exit fullscreen mode. 🖥️
• Orientation Control: Lock and unlock screen orientation. 🔄
• Home Screen Integration: Add the app to the home screen. 🏠
• Event Handling: Listen to and manage app events. 🎧

---

Installation ⚙️

To install the package, run the following command:

npm install telegram-mini-apps-2.0

---

Usage 🛠️

Importing the Package

import { TelegramWebApp } from 'telegram-mini-apps-2.0';

// Initialize the app
TelegramWebApp.ready();

// Set header color
TelegramWebApp.setHeaderColor('#ffffff');

// Show the back button
TelegramWebApp.BackButton.show();

// Set main button text
TelegramWebApp.MainButton.setText('Submit');

// Handle main button click
TelegramWebApp.MainButton.onClick(() => {
  console.log('Main button clicked!');
});

// Provide haptic feedback
TelegramWebApp.HapticFeedback.impactOccurred('medium');

// Get device location
TelegramWebApp.LocationManager.getLocation((location) => {
  console.log('Location:', location);
});

// Scan QR code
TelegramWebApp.QRScanner.show({ text: 'Scan QR Code' }, (data) => {
  console.log('QR Code data:', data);
});

// Read text from clipboard
TelegramWebApp.Clipboard.readText((text) => {
  console.log('Clipboard text:', text);
});

// Share media to story
TelegramWebApp.Share.shareToStory('https://example.com/media');

// Enter fullscreen mode
TelegramWebApp.Fullscreen.requestFullscreen();

// Lock screen orientation
TelegramWebApp.Orientation.lockOrientation();

// Add app to home screen
TelegramWebApp.HomeScreen.addToHomeScreen();

// Listen to events
TelegramWebApp.Events.onEvent('viewportChanged', (data) => {
  console.log('Viewport changed:', data);
});

---

Modules 📚

Core Modules

BackButton: Control the back button in the Mini App header. ↩️

MainButton: Manage the main button at the bottom of the Mini App. 🎯

HapticFeedback: Provide haptic feedback for user interactions. 📳

CloudStorage: Store and retrieve user-specific data. ☁️

BiometricManager: Handle biometric authentication. 🔒

LocationManager: Access and manage device location. 🌍

Accelerometer: Access accelerometer data. 📡

DeviceOrientation: Access device orientation data. 🔄

Gyroscope: Access gyroscope data. 🌀

SettingsButton: Control the settings button in the Mini App. ⚙️

Utility Modules

Invoice: Open and manage invoices. 💳

QRScanner: Scan QR codes. 📷

Clipboard: Read text from the clipboard. 📋

Share: Share media to stories and messages. 📤

Fullscreen: Manage fullscreen mode. 🖥️

Orientation: Control screen orientation. 🔄

HomeScreen: Add the app to the home screen. 🏠

Contributing 🤝

We welcome contributions! If you'd like to contribute to this project, please follow these steps:

Fork the repository. 🍴
Create a new branch for your feature or bugfix. 🌿
Commit your changes. 💾
Push your branch to your fork. 🚀
Submit a pull request. 🎉

License 📄

This project is licensed under the MIT License. See the LICENSE file for details.

Support 💬

If you have any questions or need support, feel free to open an issue on GitHub or reach out to us at antontuzovj@gmail.com

Acknowledgments 🙏

Thanks to Telegram for providing the Mini Apps platform. 📱

Special thanks to all contributors who helped make this project better. 🌟

Happy Coding! 🎉👨‍💻👩‍💻