@apiteam/twa-bridge 8.0.4 → 8.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -77
- package/package.json +1 -1
- package/solid/index.d.ts +1 -1
package/README.md
CHANGED
|
@@ -1,90 +1,34 @@
|
|
|
1
|
-
|
|
2
|
-
[](https://www.npmjs.com/package/@apiteam/twa-bridge)
|
|
1
|
+
# Telegram Bridge
|
|
3
2
|
|
|
4
|
-
|
|
3
|
+
## Описание
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
npm i @apiteam/twa-bridge
|
|
8
|
-
```
|
|
9
|
-
|
|
10
|
-
### Motivation
|
|
11
|
-
Telegram distributes SDK via [link](https://core.telegram.org/bots/webapps#initializing-web-apps). It's kinda old fashion way to work with a library:
|
|
12
|
-
|
|
13
|
-
```html
|
|
14
|
-
<html lang="en">
|
|
15
|
-
<head>
|
|
16
|
-
<title>TWA</title>
|
|
17
|
-
<meta charset="UTF-8">
|
|
18
|
-
<script src="https://telegram.org/js/telegram-web-app.js"></script>
|
|
19
|
-
<script>
|
|
20
|
-
window.Telegram.WebApp.showPopup({ message: 'message' });
|
|
21
|
-
</script>
|
|
22
|
-
</head>
|
|
23
|
-
<body></body>
|
|
24
|
-
</html>
|
|
25
|
-
```
|
|
5
|
+
Библиотека для работы с Telegram WebApp API, предоставляющая удобный интерфейс для взаимодействия с функциями Telegram Mini Apps. Реализована на TypeScript с поддержкой строгой типизации.
|
|
26
6
|
|
|
27
|
-
|
|
7
|
+
## Полная документация
|
|
8
|
+
[Документация API](https://docs.apiteam.ru)
|
|
28
9
|
|
|
29
|
-
|
|
30
|
-
import { bridgeOpenPopup } from '@apiteam/twa-bridge/solid'
|
|
10
|
+
## Основные возможности
|
|
31
11
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
### Solid
|
|
38
|
-
```js
|
|
39
|
-
import {
|
|
40
|
-
listener,
|
|
41
|
-
EventViewportChanged,
|
|
42
|
-
bridgeRequestViewport
|
|
43
|
-
} from '@apiteam/twa-bridge/solid'
|
|
12
|
+
- Управление внешним видом WebApp (цвета, кнопки)
|
|
13
|
+
- Работа с платежами и инвойсами
|
|
14
|
+
- Взаимодействие с QR-сканером
|
|
15
|
+
- Управление буфером обмена
|
|
16
|
+
- Обработка системных событий Telegram
|
|
44
17
|
|
|
45
|
-
|
|
46
|
-
eventData: EventsData[typeof EventViewportChanged]
|
|
47
|
-
) => {
|
|
48
|
-
console.log({eventData})
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
listener.on(EventViewportChanged, onRequestViewport)
|
|
52
|
-
bridgeRequestViewport()
|
|
18
|
+
## Установка
|
|
53
19
|
|
|
20
|
+
```bash
|
|
21
|
+
npm install @apiteam/twa-bridge
|
|
54
22
|
```
|
|
55
|
-
### Use Context
|
|
56
|
-
```js
|
|
57
|
-
import {
|
|
58
|
-
ProviderTWA,
|
|
59
|
-
ContextTwa
|
|
60
|
-
} from '@apiteam/twa-bridge/solid'
|
|
61
23
|
|
|
62
|
-
|
|
63
|
-
return (
|
|
64
|
-
<ProviderTWA>
|
|
65
|
-
<App />
|
|
66
|
-
</ProviderTWA>
|
|
67
|
-
)
|
|
68
|
-
}
|
|
24
|
+
# Поддержка
|
|
69
25
|
|
|
70
|
-
|
|
71
|
-
const context = useContext(ContextTwa)
|
|
72
|
-
|
|
73
|
-
return <div>FisrtName: {context.init?.user?.first_name}</div>
|
|
74
|
-
}
|
|
26
|
+
Если у вас возникли вопросы или проблемы:
|
|
75
27
|
|
|
76
|
-
|
|
28
|
+
## Способы связи
|
|
77
29
|
|
|
78
|
-
|
|
30
|
+
- [Создать issue в GitHub](https://github.com/apiteamru/twa-bridge/issues)
|
|
31
|
+
_(Для багрепортов и запросов функций)_
|
|
79
32
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
| 1 | Method not supported |
|
|
83
|
-
| 2 | Ooof! Something is wrong. Init data is missing |
|
|
84
|
-
| 3 | Title too long, maximum length 64 characters |
|
|
85
|
-
| 4 | Your message is too short, at least 1 character |
|
|
86
|
-
| 5 | Your message is too long, maximum 256 characters |
|
|
87
|
-
| 6 | You are passing too few buttons, at least 1 button |
|
|
88
|
-
| 7 | You are passing too many buttons, maximum 3 buttons |
|
|
89
|
-
| 8 | The button text ignores the following values: "ok, close, cancel" |
|
|
90
|
-
| 9 | EDIT_MESSAGE |
|
|
33
|
+
- Написать в Telegram: [@apiteam_help](https://t.me/apiteam_help)
|
|
34
|
+
_(Быстрая помощь в реальном времени)_
|
package/package.json
CHANGED