vRouter는 모든 플랫폼에서 라우팅 및 탐색을 단순화하는 Flutter용 네비게이션 패키지입니다. Navigator 2 위에 구축되어 있으며, 중첩된 경로, 딥링크, 동적 경로 처리를 지원하는 선언적이고 유형 안전한 방식으로 앱 탐색을 관리합니다. 빌더플레이트를 줄이고 경로 관리의 확장성을 향상시켜 개발자 경험을 향상시킵니다. 이 패키지는 플랫폼에 관계없는 라우팅 로직을 지원하여 일관된 탐색 동작이 필요한 복잡한 애플리케이션에 적합합니다.
사용 사례
중첩 탐색을 갖춘 단일 페이지 애플리케이션
통합 라우팅이 필요한 크로스 플랫폼 앱
딥링크 지원이 필요한 앱
동적 세그먼트를 가진 복잡한 경로 계층
네비게이션 흐름에서의 상태 관리 간소화
주요 기능
선언적 라우팅 구성
중첩 및 동적 경로 지원
현대적인 라우팅을 위한 Navigator 2 기반
플랫폼에 관계없는 탐색 로직
타입 안전한 경로 정의
기존 Flutter 앱과의 간편한 통합
적합한 대상
확장 가능한 Flutter 앱을 개발하는 개발자
복잡한 탐색 구조를 관리하는 팀
딥 링크 및 URL 처리가 필요한 프로젝트
일관된 라우팅을 갖춘 다중 플랫폼 대상 앱
더 깔끔하고 유지보수하기 쉬운 네비게이션 코드를 원하는 개발자
고려 사항
Navigator 2 개념을 이해해야 합니다
고급 사용 사례를 위해 추가 설정이 필요할 수 있습니다
메인스트림 패키지에 비해 문서가 제한적
구조화된 탐색이 필요한 앱에 가장 적합
원본 README
연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.
A Flutter package that makes navigation and routing easy.
VRouter is a widget which handles the navigation, it acts as a MaterialApp but also takes a routes arguments.
VRouter(
debugShowCheckedModeBanner: false, // VRouter acts as a MaterialApp
routes: [...], // Put your VRouteElements here
)
VRouteElements
VRouteElements are the building blocs of your routes.
Note that they are not widgets but the way you use them is very similar to widgets.
VWidget
VWidget maps a path to a widget:
VWidget(path: '/login', widget: LoginScreen())
VGuard
VGuard allows you to take actions when the route is accessed/leaved:
VGuard(
beforeEnter: (vRedirector) async => , // Triggered when a route in stackedRoutes is first displayed
beforeUpdate: (vRedirector) async => , // Triggered when a route in stackedRoutes is displayed but changes
beforeLeave: (vRedirector, _) async => , // Triggered when VGuard is not part of a new route
stackedRoutes: [...],
);
VRouteRedirector
VRouteRedirector redirects from a route to another:
VNester are used when you need to nested widgets instead of stacking them:
VNester(
path: '/home',
widgetBuilder: (child) => MyScaffold(body: child), // child will take the value of the widget in nestedRoutes
nestedRoutes: [
VWidget(path: 'profile', widget: ProfileScreen()), // path '/home/profile'VWidget(path: 'settings', widget: SettingsScreen()), // path '/home/settings'
],
)
VPopHandler
VPopHandler helps you control pop events:
VPopHandler(
onPop: (vRedirector) async =>, // Called when this VRouteElement is popped
onSystemPop: (vRedirector) async =>, // Called when this VRouteElement is popped by android back button
stackedRoutes: [...],
)
Navigation
Navigating is easy, just access VRouter with context.vRouter and navigate:
context.vRouter.to('/home'); // Push the url '/home'
context.vRouter.toSegments(['home', 'settings']); // Push the url '/home/settings'
Useful notions
Composition
VRouteElements are designed like widgets: compose them to create the route you need.
Compose VRouteElements
To compose VRouteElements, use the stackedRoutes attribute (or the nestedRoutes attribute for VNester):
// Composing a VGuard and a VWidgetVGuard(
beforeEnter: (vRedirector) async => !isLoggedIn ? vRedirector.to('/login') : null,
stackedRoutes: [
VWidget(path: '/home', widget: HomeScreen()),
],
)
Create custom VRouteElements
You can even create your own VRouteElement, as you extend VWidget. You just need to extends VRouteElementBuilder:
VRouter contains data (such as the path or path parameters) that you might want to access in your widget tree. There are 2 ways of doing do:
// Use the context
context.vRouter
// Use the builder constructor of some VWidget or VNesterVWidget.builder(
path: '/:id',
builder: (context, state) => Book(id: state.pathParameters['id'] asint),
)
Go Beyond
We have just scratched the surface of what VRouter can do. Here are a few other things which you might like.
Initial url
Maybe you want to redirect people to a certain part of your app when they first launch it, then use initialUrl:
VRouter(
initialUrl: '/home',
routes: [...],
)
Logs
By default, VRouter shows logs of every navigation events.
You can remove these logs using VLogs.none:
VRouter(
logs: VLogs.none,
routes: [...],
);
Named route
You might have to access a deeply nested VRouteElement and don’t want to have to write the full url. Just give a name to this VRouteElement:
You can either specify a default transition in VRouter, or a custom one in VWidget or VNester
VRouter(
// Default transition
buildTransition: (animation1, _, child) => FadeTransition(opacity: animation1, child: child),
routes: [
// The custom ScaleTransition will play for '/user'VWidget(
path: '/user',
widget: UsersScreen(),
buildTransition: (animation1, _, child) => ScaleTransition(scale: animation1, child: child),
)
// The default FadeTransition will play for '/settings'VWidget(path: '/settings', widget: SettingsScreen()),
],
)
Much more
There is so much more that this package can do, check out the example
or have a look at the vrouter.dev website for more documentation and more examples.