Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kolirt/vue-telegram-mini-app
📱 Vue 3 telegram mini app package
https://github.com/kolirt/vue-telegram-mini-app
mini-app telegram-mini-app tma vue vue-packages vue-plugin
Last synced: about 1 month ago
JSON representation
📱 Vue 3 telegram mini app package
- Host: GitHub
- URL: https://github.com/kolirt/vue-telegram-mini-app
- Owner: kolirt
- License: mit
- Created: 2024-05-16T11:00:33.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-08-19T16:44:51.000Z (5 months ago)
- Last Synced: 2024-11-06T21:07:18.607Z (2 months ago)
- Topics: mini-app, telegram-mini-app, tma, vue, vue-packages, vue-plugin
- Language: TypeScript
- Homepage:
- Size: 127 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Vue 3 telegram mini apps
Vue 3 telegram mini app package
## Structure
- [Getting started](#getting-started)
- [Installation](#installation)
- [Setup](#setup)
- [Telegram Mini Apps API implementation status](#telegram-mini-apps-api-implementation-status)
- [window.Telegram.WebApp](#windowtelegramwebapp)
- [Faq](#faq)
- [License](#license)
- [Other projects](#other-projects)
## Getting started
### Installation
```bash
npm install --save @kolirt/vue-telegram-mini-app
yarn add @kolirt/vue-telegram-mini-app
```
### Setup
```javascript
import { createApp } from 'vue'
import { createTelegramMiniApp } from '@kolirt/vue-telegram-mini-app'
const app = createApp({ ... })
app.use(createTelegramMiniApp({
alwaysExpand: true,
closingConfirmation: true
}))
app.mount('#app')
```
## Telegram Mini Apps API implementation status
### [window.Telegram.WebApp](https://core.telegram.org/bots/webapps#initializing-mini-apps)
- [X] initData
- [ ] initDataUnsafe
- [X] version
- [X] platform
- [X] colorScheme
- [ ] themeParams
- [X] isExpanded
- [X] viewportHeight
- [X] viewportStableHeight
- [X] headerColor
- [X] backgroundColor
- [X] isClosingConfirmationEnabled
- [X] isVerticalSwipesEnabled
- [ ] BackButton
- [ ] isVisible
- [X] BackButton.onClick
- [X] BackButton.offClick
- [X] BackButton.show
- [X] BackButton.hide
- [ ] MainButton
- [ ] SettingsButton
- [X] HapticFeedback
- [X] HapticFeedback.impactOccurred
- [X] HapticFeedback.notificationOccurred
- [X] HapticFeedback.selectionChanged
- [X] CloudStorage
- [X] CloudStorage.setItem
- [X] CloudStorage.getItem
- [X] CloudStorage.getItems
- [X] CloudStorage.removeItem
- [X] CloudStorage.removeItems
- [X] CloudStorage.getKeys
- [ ] BiometricManager
- [X] isVersionAtLeast
- [X] setHeaderColor(color)
- [X] setBackgroundColor(color)
- [X] enableClosingConfirmation()
- [X] disableClosingConfirmation()
- [X] enableVerticalSwipes()
- [X] disableVerticalSwipes()
- [X] onEvent(eventType, eventHandler)
- [X] offEvent(eventType, eventHandler)
- [ ] sendData(data)
- [ ] switchInlineQuery(query[, choose_chat_types])
- [ ] openLink(url[, options])
- [ ] openTelegramLink(url)
- [ ] openInvoice(url[, callback])
- [ ] showPopup(params[, callback])
- [ ] showAlert(message[, callback])
- [ ] showConfirm(message[, callback])
- [ ] showScanQrPopup(params[, callback])
- [ ] closeScanQrPopup()
- [ ] readTextFromClipboard([callback])
- [ ] requestWriteAccess([callback])
- [ ] requestContact([callback])
- [X] ready()
- [X] expand()
- [X] close()
## FAQ
Check closed [issues](https://github.com/kolirt/vue-telegram-mini-app/issues) with `FAQ` label to get answers for most asked
questions
## License
[MIT](./LICENSE)
## Other projects
Check out my other projects on my [GitHub profile](https://github.com/kolirt)