https://github.com/worldwidebaby/router
:test_tube: A declarative, flexible, and native-like router for mini-apps
https://github.com/worldwidebaby/router
opensource react router typescript vk-mini-apps vkui
Last synced: 14 days ago
JSON representation
:test_tube: A declarative, flexible, and native-like router for mini-apps
- Host: GitHub
- URL: https://github.com/worldwidebaby/router
- Owner: worldwidebaby
- License: mit
- Created: 2020-12-12T19:03:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-25T18:11:47.000Z (about 1 month ago)
- Last Synced: 2025-05-08T11:44:35.630Z (21 days ago)
- Topics: opensource, react, router, typescript, vk-mini-apps, vkui
- Language: TypeScript
- Homepage:
- Size: 977 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Роутер для мини-приложений
Легковесный, удобный, многофункциональный роутер для разработки продвинутых
мини-приложений с навигацией любой сложности.
- :snowflake: **TypeScript**. Поддерживает типизацию.
- :heart_eyes: **Concurrent Mode**. Поддержка [конкурентного рендеринга](docs/concurrent.md).
- :new_moon: **Декларативный**. Ваша структура приложения – это описание маршрутов.
- :ghost: **Нативный**. Реализует нативное поведение навигации.
- :dragon_face: **Многофункциональный**. Поддерживает навигацию любой сложности.
- :earth_americas: **Легковесный**. Весь функционал роутера займет всего [~3kB](https://bundlephobia.com/package/@unexp/router@alpha).
## Установка
Используя yarn:
```shell
yarn add @unexp/router@beta
```
Или используя npm:
```shell
npm i @unexp/router@beta
```
## Документация
1. [Определение структуры](docs/structure.md)
2. [Переходы](docs/transitions.md)
3. [Обработка свайпов](docs/swipes.md)
4. [Модальные окна](docs/modals.md)
5. [Слушатели](docs/listeners.md)
6. [Конкурентный режим](docs/concurrent.md)
7. [Справочник API](docs/api.md)
## Лицензия
[MIT](LICENSE)