https://github.com/vkcom/vk-mini-apps-router
https://github.com/vkcom/vk-mini-apps-router
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vkcom/vk-mini-apps-router
- Owner: VKCOM
- License: mit
- Created: 2023-04-24T11:55:58.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T20:25:07.000Z (over 1 year ago)
- Last Synced: 2025-04-10T01:08:23.413Z (about 1 year ago)
- Language: TypeScript
- Size: 1.82 MB
- Stars: 26
- Watchers: 13
- Forks: 7
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# vk-mini-apps-router
Библиотека vk-mini-apps-router — решение для декларативной маршрутизации и навигации для [мини-приложений](https://dev.vk.com/mini-apps/overview) ВКонтакте, созданных с помощью библиотеки [VKUI](https://github.com/VKCOM/VKUI).
## Ключевые особенности
* Интеграция с [VKUI](https://github.com/VKCOM/VKUI), поддержка React-компонентов этой библиотеки.
Ваше мини-приложение будет органично вписываться в интерфейс ВКонтакте и использовать такие же визуальные эффекты при вызовы или скрытии окон и экранов.
* Поддержка навигации по экранам приложения. Возможность открытия любого экрана в мини-приложении по прямой ссылке (включая модальные и всплывающие окна).
* Отображение модальных и всплывающих окон без изменения URL в приложении, но с возможностью закрытия этих окон кнопкой «Назад».
* Интеграция с библиотекой [VK Bridge](https://github.com/VKCOM/vk-bridge).
* Встроенная обработка ошибки 404 Not Found.
## Установка и использование
### yarn
`yarn add @vkontakte/vk-mini-apps-router`
### npm
`npm install @vkontakte/vk-mini-apps-router`
### Использование VK Bridge
Библиотека [VK Bridge](https://github.com/VKCOM/vk-bridge) не включена в репозиторий. Устанавливайте её самостоятельно.
## Документация и ресурсы
* https://dev.vk.com/libraries/router — документация библиотеки.
* [Пример использования](https://github.com/VKCOM/vk-mini-apps-router/tree/master/examples/vk-mini-apps-router-example).
* [VK Mini Apps](https://vk.com/vkappsdev) — сообщество разработчиков мини-приложений ВКонтакте.