{"id":15134220,"url":"https://github.com/sally-framework/vk-keyboard","last_synced_at":"2026-01-27T06:31:09.605Z","repository":{"id":62539581,"uuid":"255094121","full_name":"Sally-Framework/vk-keyboard","owner":"Sally-Framework","description":"Библиотека для конструирования объектов клавиатур vk api  ","archived":false,"fork":false,"pushed_at":"2020-04-16T17:27:00.000Z","size":528,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-05T22:42:19.073Z","etag":null,"topics":["vk","vk-api","vk-bot","vk-sdk","vkapi","vkbot","vkontakte","vkontakte-api","vkontakte-client","vkontakte-sdk"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sally-Framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-12T13:58:45.000Z","updated_at":"2024-02-12T16:23:08.000Z","dependencies_parsed_at":"2022-11-02T16:16:11.567Z","dependency_job_id":null,"html_url":"https://github.com/Sally-Framework/vk-keyboard","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sally-Framework%2Fvk-keyboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sally-Framework%2Fvk-keyboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sally-Framework%2Fvk-keyboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sally-Framework%2Fvk-keyboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sally-Framework","download_url":"https://codeload.github.com/Sally-Framework/vk-keyboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411194,"owners_count":20934650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vk","vk-api","vk-bot","vk-sdk","vkapi","vkbot","vkontakte","vkontakte-api","vkontakte-client","vkontakte-sdk"],"created_at":"2024-09-26T05:03:52.340Z","updated_at":"2026-01-27T06:31:09.578Z","avatar_url":"https://github.com/Sally-Framework.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VK Keyboard\n[![Latest Version](https://badgen.net/packagist/v/sally/vk-keyboard)](https://packagist.org/packages/sally/vk-keyboard)\n[![Licence](https://badgen.net/badge/license/MIT/blue)](LICENCE)\n[![Last Commit](https://badgen.net/github/last-commit/Sally-Framework/vk-keyboard)](https://github.com/Sally-Framework/vk-keyboard)\n## Установка\n\nПеред установкой рекомендую ознакомиться с последними обновлениями api вконтакте, \nа также прочитать про типы кнопок, клавиатур, каруселей и особенностей работы с api вконтакте.\n[Документация клавиатур](https://vk.com/dev/bots_docs_3)\n\n```bash\n$ composer require sally/vk-keyboard\n```\n\n## Использование\nНа момент создания библиотеки api вконтакте поддерживает 3 типа клавиатур, а именно inline, обычная клавиатура и карусели\n## Обычные\n![Basic](images/vk_basic.jpg)\n## Inline\n![Inline](images/vk_inline.jpg)\n## Карусели\n![Open Link](images/vk_carousel.jpg)\n\n\nЧтобы создать такие объекты кавиатур воспользуйтесь фасадом-конструктором этих объектов.\n\n## Для создания обычной клавиатуры\n```php\n\u003c?php\n\nrequire '../vendor/autoload.php';\n\nuse Sally\\VkKeyboard\\Facade;\nuse Sally\\VkKeyboard\\Contracts\\Keyboard\\Button\\FactoryInterface;\nuse Sally\\VkKeyboard\\Object\\Keyboard\\Button\\Text;\n\n$keyboard = Facade::createKeyboardBasic(function (FactoryInterface $factory) {\n    return [\n        [\n            $factory-\u003elocation([]),\n        ],\n        [\n            $factory-\u003etext('Текстовая кнопка', ['button' =\u003e 1], Text::COLOR_RED),\n            $factory-\u003elink('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),\n        ],\n        [\n            $factory-\u003epay('action=transfer-to-group\u0026group_id=1\u0026aid=10')\n        ],\n        [\n            $factory-\u003eapp('Кнопка приложения', 6979558, '-181108510', 'sendKeyboard')\n        ]\n    ];\n});\n\n```\n\nФасад сконвертирует клавиатуру в json, согласно требованиям api вконтакте\n```json\n{\n  \"one_time\": true,\n  \"buttons\": [\n    [\n      {\n        \"action\": {\n          \"payload\": \"[]\",\n          \"type\": \"location\"\n        }\n      }\n    ],\n    [\n      {\n        \"color\": \"negative\",\n        \"action\": {\n          \"payload\": \"{\\\"button\\\":1}\",\n          \"label\": \"Текстовая кнопка\",\n          \"type\": \"text\"\n        }\n      },\n      {\n        \"action\": {\n          \"link\": \"https:\\/\\/github.com\\/Sally-Framework\\/vk-keyboard\",\n          \"label\": \"Кнопка с ссылкой\",\n          \"payload\": \"[]\",\n          \"type\": \"open_link\"\n        }\n      }\n    ],\n    [\n      {\n        \"action\": {\n          \"hash\": \"action=transfer-to-group\u0026group_id=1\u0026aid=10\",\n          \"type\": \"vkpay\"\n        }\n      }\n    ],\n    [\n      {\n        \"action\": {\n          \"app_id\": 6979558,\n          \"owner_id\": \"-181108510\",\n          \"hash\": \"sendKeyboard\",\n          \"label\": \"Кнопка приложения\",\n          \"type\": \"open_app\"\n        }\n      }\n    ]\n  ]\n}\n```\n\nЕсли отправить такую клавиатуру, то она будет отображена в таком виде\n![Keyboard](images/basic_keyboard.png)\n\n## Для Inline клавиатуры\n```php\n\u003c?php\n\nrequire '../vendor/autoload.php';\n\nuse Sally\\VkKeyboard\\Facade;\nuse Sally\\VkKeyboard\\Contracts\\Keyboard\\Button\\FactoryInterface;\nuse Sally\\VkKeyboard\\Object\\Keyboard\\Button\\Text;\n\n$keyboard = Facade::createKeyboardInline(function (FactoryInterface $factory) {\n    return [\n        [\n            $factory-\u003elocation([]),\n        ],\n        [\n            $factory-\u003etext('Текстовая кнопка', ['button' =\u003e 1], Text::COLOR_RED),\n            $factory-\u003elink('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),\n        ],\n        [\n            $factory-\u003epay('action=transfer-to-group\u0026group_id=1\u0026aid=10')\n        ],\n        [\n            $factory-\u003eapp('Кнопка приложения', 6979558, '-181108510', 'sendKeyboard')\n        ]\n    ];\n});\n\n```\n\n```json\n{\n  \"inline\": true,\n  \"buttons\": [\n    [\n      {\n        \"action\": {\n          \"payload\": \"[]\",\n          \"type\": \"location\"\n        }\n      }\n    ],\n    [\n      {\n        \"color\": \"negative\",\n        \"action\": {\n          \"payload\": \"{\\\"button\\\":1}\",\n          \"label\": \"Текстовая кнопка\",\n          \"type\": \"text\"\n        }\n      },\n      {\n        \"action\": {\n          \"link\": \"https:\\/\\/github.com\\/Sally-Framework\\/vk-keyboard\",\n          \"label\": \"Кнопка с ссылкой\",\n          \"payload\": \"[]\",\n          \"type\": \"open_link\"\n        }\n      }\n    ],\n    [\n      {\n        \"action\": {\n          \"hash\": \"action=transfer-to-group\u0026group_id=1\u0026aid=10\",\n          \"type\": \"vkpay\"\n        }\n      }\n    ],\n    [\n      {\n        \"action\": {\n          \"app_id\": 6979558,\n          \"owner_id\": \"-181108510\",\n          \"hash\": \"sendKeyboard\",\n          \"label\": \"Кнопка приложения\",\n          \"type\": \"open_app\"\n        }\n      }\n    ]\n  ]\n}\n```\n\n![Inline](images/inline_keyboard.png)\n\n## Для каруселей\n```php\n\u003c?php\n\nrequire '../vendor/autoload.php';\n\nuse Sally\\VkKeyboard\\Facade;\nuse Sally\\VkKeyboard\\Contracts\\Keyboard\\Button\\FactoryInterface as ButtonFactoryInterface;\nuse Sally\\VkKeyboard\\Contracts\\Template\\Carousel\\Element\\FactoryInterface as CarouselElementInterface;\n\n$templateWithOpenPhoto = Facade::createCarousel(function (CarouselElementInterface $elementFactory, ButtonFactoryInterface $buttonFactory) {\n    return [\n        $elementFactory-\u003eopenPhoto([\n            $buttonFactory-\u003elocation(['button' =\u003e 'location']),\n            $buttonFactory-\u003epay('action=transfer-to-group\u0026group_id=1\u0026aid=10'),\n            $buttonFactory-\u003elink('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),\n        ], 'Карусель Open Photo', 'По нажатию у вас откроется картинка', '-109837093_457242809'),\n        $elementFactory-\u003eopenPhoto([\n            $buttonFactory-\u003elocation(['button' =\u003e 'location']),\n            $buttonFactory-\u003epay('action=transfer-to-group\u0026group_id=1\u0026aid=10'),\n            $buttonFactory-\u003elink('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),\n        ], 'Карусель Open Photo', 'По нажатию у вас откроется картинка', '-109837093_457242809'),\n        $elementFactory-\u003eopenPhoto([\n            $buttonFactory-\u003elocation(['button' =\u003e 'location']),\n            $buttonFactory-\u003epay('action=transfer-to-group\u0026group_id=1\u0026aid=10'),\n            $buttonFactory-\u003elink('Кнопка с ссылкой', 'https://github.com/Sally-Framework/vk-keyboard', []),\n        ], 'Карусель Open Photo', 'По нажатию у вас откроется картинка', '-109837093_457242809'),\n    ];\n});\n\n```\n\n```json\n{\n  \"elements\": [\n    {\n      \"buttons\": [\n        {\n          \"action\": {\n            \"payload\": \"{\\\"button\\\":\\\"location\\\"}\",\n            \"type\": \"location\"\n          }\n        },\n        {\n          \"action\": {\n            \"hash\": \"action=transfer-to-group\u0026group_id=1\u0026aid=10\",\n            \"type\": \"vkpay\"\n          }\n        },\n        {\n          \"action\": {\n            \"link\": \"https:\\/\\/github.com\\/Sally-Framework\\/vk-keyboard\",\n            \"label\": \"Кнопка с ссылкой\",\n            \"payload\": \"[]\",\n            \"type\": \"open_link\"\n          }\n        }\n      ],\n      \"title\": \"Карусель Open Photo\",\n      \"description\": \"По нажатию у вас откроется картинка\",\n      \"photo_id\": \"-109837093_457242809\",\n      \"action\": {\n        \"type\": \"open_photo\"\n      }\n    },\n    {\n      \"buttons\": [\n        {\n          \"action\": {\n            \"payload\": \"{\\\"button\\\":\\\"location\\\"}\",\n            \"type\": \"location\"\n          }\n        },\n        {\n          \"action\": {\n            \"hash\": \"action=transfer-to-group\u0026group_id=1\u0026aid=10\",\n            \"type\": \"vkpay\"\n          }\n        },\n        {\n          \"action\": {\n            \"link\": \"https:\\/\\/github.com\\/Sally-Framework\\/vk-keyboard\",\n            \"label\": \"Кнопка с ссылкой\",\n            \"payload\": \"[]\",\n            \"type\": \"open_link\"\n          }\n        }\n      ],\n      \"title\": \"Карусель Open Photo\",\n      \"description\": \"По нажатию у вас откроется картинка\",\n      \"photo_id\": \"-109837093_457242809\",\n      \"action\": {\n        \"type\": \"open_photo\"\n      }\n    },\n    {\n      \"buttons\": [\n        {\n          \"action\": {\n            \"payload\": \"{\\\"button\\\":\\\"location\\\"}\",\n            \"type\": \"location\"\n          }\n        },\n        {\n          \"action\": {\n            \"hash\": \"action=transfer-to-group\u0026group_id=1\u0026aid=10\",\n            \"type\": \"vkpay\"\n          }\n        },\n        {\n          \"action\": {\n            \"link\": \"https:\\/\\/github.com\\/Sally-Framework\\/vk-keyboard\",\n            \"label\": \"Кнопка с ссылкой\",\n            \"payload\": \"[]\",\n            \"type\": \"open_link\"\n          }\n        }\n      ],\n      \"title\": \"Карусель Open Photo\",\n      \"description\": \"По нажатию у вас откроется картинка\",\n      \"photo_id\": \"-109837093_457242809\",\n      \"action\": {\n        \"type\": \"open_photo\"\n      }\n    }\n  ],\n  \"type\": \"carousel\"\n}\n```\n\n![Carousel](images/open_photo.png)\n\n## Примеры\nБолее детальные примеры представлены [здесь](examples).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsally-framework%2Fvk-keyboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsally-framework%2Fvk-keyboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsally-framework%2Fvk-keyboard/lists"}