Aus öffentlichen Paketdaten erstellte Orientierung.
vRouter ist ein Navigationspaket für Flutter, das die Routing- und Navigationsverwaltung auf allen Plattformen vereinfacht. Auf Basis von Navigator 2 bietet es eine deklarative und typsichere Möglichkeit, die App-Navigation mit verschachtelten Routen, Deep Linking und dynamischer Route-Verarbeitung zu verwalten. Es verbessert die Entwicklererfahrung durch Reduzierung von Boilerplate-Code und Verbesserung der Skalierbarkeit der Routenverwaltung. Das Paket unterstützt plattformunabhängige Routing-Logik und ist daher ideal für komplexe Anwendungen, die konsistentes Navigationsverhalten erfordern.
Anwendungsfälle
Einseitige Anwendungen mit verschachtelter Navigation
Plattformübergreifende Anwendungen, die eine einheitliche Routing-Unterstützung benötigen
Apps, die Deep-Linking-Unterstützung erfordern
Komplexe Routenhierarchien mit dynamischen Segmenten
Einfache Zustandsverwaltung in Navigationsflüssen
Hauptmerkmale
Deklarative Routenkonfiguration
Unterstützung für verschachtelte und dynamische Routen
Aufbau auf Navigator 2 für modernes Routing
plattformunabhängige Navigationslogik
Typensichere Routendefinitionen
Einfache Integration in bestehende Flutter-Apps
Geeignet für
Entwickler, die skalierbare Flutter-Apps erstellen
Teams, die komplexe Navigationsstrukturen verwalten
Projekte, die tiefe Linking und URL-Verarbeitung erfordern
Apps, die mehrere Plattformen mit konsistenter Routing-Zielsetzung ansprechen
Entwickler, die sauberen, wartungsfreundlicheren Navigationscode suchen
Hinweise
Erfordert Verständnis der Navigator 2-Konzepte
Für erweiterte Anwendungsfälle kann möglicherweise zusätzliche Einrichtung erforderlich sein
Eingeschränkte Dokumentation im Vergleich zu Mainstream-Paketen
Am besten geeignet für Apps mit strukturierten Navigationsanforderungen
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
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.