Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sally-framework/vk-keyboard
Библиотека для конструирования объектов клавиатур vk api
https://github.com/sally-framework/vk-keyboard
vk vk-api vk-bot vk-sdk vkapi vkbot vkontakte vkontakte-api vkontakte-client vkontakte-sdk
Last synced: 23 days ago
JSON representation
Библиотека для конструирования объектов клавиатур vk api
- Host: GitHub
- URL: https://github.com/sally-framework/vk-keyboard
- Owner: Sally-Framework
- License: mit
- Created: 2020-04-12T13:58:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-16T17:27:00.000Z (over 4 years ago)
- Last Synced: 2024-12-16T00:33:31.633Z (26 days ago)
- Topics: vk, vk-api, vk-bot, vk-sdk, vkapi, vkbot, vkontakte, vkontakte-api, vkontakte-client, vkontakte-sdk
- Language: PHP
- Size: 516 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VK Keyboard
[](https://packagist.org/packages/sally/vk-keyboard)
[](LICENCE)
[](https://github.com/Sally-Framework/vk-keyboard)
## Установка
Перед установкой рекомендую ознакомиться с последними обновлениями api вконтакте,
а также прочитать про типы кнопок, клавиатур, каруселей и особенностей работы с api вконтакте.
[Документация клавиатур](https://vk.com/dev/bots_docs_3)
```bash
$ composer require sally/vk-keyboard
```
## Использование
На момент создания библиотеки api вконтакте поддерживает 3 типа клавиатур, а именно inline, обычная клавиатура и карусели
## Обычные
## Inline
## Карусели
Чтобы создать такие объекты кавиатур воспользуйтесь фасадом-конструктором этих объектов.
## Для создания обычной клавиатуры
```php
location([]),
],
[
$factory->text('Текстовая кнопка', ['button' => 1], Text::COLOR_RED),
$factory->link('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),
],
[
$factory->pay('action=transfer-to-group&group_id=1&aid=10')
],
[
$factory->app('Кнопка приложения', 6979558, '-181108510', 'sendKeyboard')
]
];
});
```
Фасад сконвертирует клавиатуру в json, согласно требованиям api вконтакте
```json
{
"one_time": true,
"buttons": [
[
{
"action": {
"payload": "[]",
"type": "location"
}
}
],
[
{
"color": "negative",
"action": {
"payload": "{\"button\":1}",
"label": "Текстовая кнопка",
"type": "text"
}
},
{
"action": {
"link": "https:\/\/github.com\/Sally-Framework\/vk-keyboard",
"label": "Кнопка с ссылкой",
"payload": "[]",
"type": "open_link"
}
}
],
[
{
"action": {
"hash": "action=transfer-to-group&group_id=1&aid=10",
"type": "vkpay"
}
}
],
[
{
"action": {
"app_id": 6979558,
"owner_id": "-181108510",
"hash": "sendKeyboard",
"label": "Кнопка приложения",
"type": "open_app"
}
}
]
]
}
```
Если отправить такую клавиатуру, то она будет отображена в таком виде
## Для Inline клавиатуры
```php
location([]),
],
[
$factory->text('Текстовая кнопка', ['button' => 1], Text::COLOR_RED),
$factory->link('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),
],
[
$factory->pay('action=transfer-to-group&group_id=1&aid=10')
],
[
$factory->app('Кнопка приложения', 6979558, '-181108510', 'sendKeyboard')
]
];
});
```
```json
{
"inline": true,
"buttons": [
[
{
"action": {
"payload": "[]",
"type": "location"
}
}
],
[
{
"color": "negative",
"action": {
"payload": "{\"button\":1}",
"label": "Текстовая кнопка",
"type": "text"
}
},
{
"action": {
"link": "https:\/\/github.com\/Sally-Framework\/vk-keyboard",
"label": "Кнопка с ссылкой",
"payload": "[]",
"type": "open_link"
}
}
],
[
{
"action": {
"hash": "action=transfer-to-group&group_id=1&aid=10",
"type": "vkpay"
}
}
],
[
{
"action": {
"app_id": 6979558,
"owner_id": "-181108510",
"hash": "sendKeyboard",
"label": "Кнопка приложения",
"type": "open_app"
}
}
]
]
}
```
## Для каруселей
```php
openPhoto([
$buttonFactory->location(['button' => 'location']),
$buttonFactory->pay('action=transfer-to-group&group_id=1&aid=10'),
$buttonFactory->link('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),
], 'Карусель Open Photo', 'По нажатию у вас откроется картинка', '-109837093_457242809'),
$elementFactory->openPhoto([
$buttonFactory->location(['button' => 'location']),
$buttonFactory->pay('action=transfer-to-group&group_id=1&aid=10'),
$buttonFactory->link('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),
], 'Карусель Open Photo', 'По нажатию у вас откроется картинка', '-109837093_457242809'),
$elementFactory->openPhoto([
$buttonFactory->location(['button' => 'location']),
$buttonFactory->pay('action=transfer-to-group&group_id=1&aid=10'),
$buttonFactory->link('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),
], 'Карусель Open Photo', 'По нажатию у вас откроется картинка', '-109837093_457242809'),
];
});
```
```json
{
"elements": [
{
"buttons": [
{
"action": {
"payload": "{\"button\":\"location\"}",
"type": "location"
}
},
{
"action": {
"hash": "action=transfer-to-group&group_id=1&aid=10",
"type": "vkpay"
}
},
{
"action": {
"link": "https:\/\/github.com\/Sally-Framework\/vk-keyboard",
"label": "Кнопка с ссылкой",
"payload": "[]",
"type": "open_link"
}
}
],
"title": "Карусель Open Photo",
"description": "По нажатию у вас откроется картинка",
"photo_id": "-109837093_457242809",
"action": {
"type": "open_photo"
}
},
{
"buttons": [
{
"action": {
"payload": "{\"button\":\"location\"}",
"type": "location"
}
},
{
"action": {
"hash": "action=transfer-to-group&group_id=1&aid=10",
"type": "vkpay"
}
},
{
"action": {
"link": "https:\/\/github.com\/Sally-Framework\/vk-keyboard",
"label": "Кнопка с ссылкой",
"payload": "[]",
"type": "open_link"
}
}
],
"title": "Карусель Open Photo",
"description": "По нажатию у вас откроется картинка",
"photo_id": "-109837093_457242809",
"action": {
"type": "open_photo"
}
},
{
"buttons": [
{
"action": {
"payload": "{\"button\":\"location\"}",
"type": "location"
}
},
{
"action": {
"hash": "action=transfer-to-group&group_id=1&aid=10",
"type": "vkpay"
}
},
{
"action": {
"link": "https:\/\/github.com\/Sally-Framework\/vk-keyboard",
"label": "Кнопка с ссылкой",
"payload": "[]",
"type": "open_link"
}
}
],
"title": "Карусель Open Photo",
"description": "По нажатию у вас откроется картинка",
"photo_id": "-109837093_457242809",
"action": {
"type": "open_photo"
}
}
],
"type": "carousel"
}
```
## Примеры
Более детальные примеры представлены [здесь](examples).