voyager library
Classes
-
AbstractRouteContext<
P> - The class supplied to custom callbacks to describe the route route
-
AbstractRouter<
O, P> - Base router implementation for given output/parameter. Ported from eyeem/router OSS project and improved upon. [...]
- Nothing
-
OutputBuilder<
O, P> -
The class used when you want to map a function (given in
run
) to a Router URL. - RedirectPlugin
- RouteBuilder
- RouteParam
- Router
- RouterContext
-
RouterObjectPlugin<
T> -
RouterParams<
O, P> - RouterPath
-
RouterPlugin<
VoyagerExtended extends Voyager> - Voyager
-
This class is a composite product of
RouterPlugin
s for the given router's path - this means all the information resolved from the navigation file that is relevant to creating new widget. Once assembled the variables are locked - they can be read but you can't put more. [...] - VoyagerArgument
-
wrapper class for argument passed via navigator
or in the constructor of
VoyagerWidget
- VoyagerParent
- this is only exposed when using cache in statless widget
- VoyagerStatelessWidget
-
Widget that allows you embed any path anywhere in the widget tree. The requirement is router
supplied in the costructor (e.g. if this is a top widget) or available via
Provider<RouterNG>.of(context)
[...] - VoyagerUtils
- VoyagerWidget
-
Just like VoyagerStatelessWidget but stateful. It has additional parameter called
keepAlive
which is usefull when embedding the widget in things likeTabBarView
. Most of the time you don't want this. Retains Voyager unless path or router changes - WidgetPlugin
- WidgetPluginBuilder
Extensions
Functions
-
loadPathsFromAssets(
String path, {AssetBundle assetBundle}) → Future< List< RouterPath> > -
loadPathsFromJsonString(
String json) → Future< List< RouterPath> > -
loadPathsFromJsonSync(
String jsonString) → List< RouterPath> -
loadPathsFromString(
String yaml) → Future< List< RouterPath> > -
loadPathsFromYamlSync(
String yaml) → List< RouterPath> -
loadRouter(
Future< List< paths, List<RouterPath> >RouterPlugin< plugins, {VoyagerFactory<Voyager> >Voyager> voyagerFactory}) → Future<Router>
Typedefs
-
OnDispose(
) → void -
ProgrammaticVoyagerFactory<
T extends Voyager> (AbstractRouteContext abstractContext, RouterContext context) → T - creates voyager instance, can be used to supply Voyager subclasses
-
VoyagerConfig<
T extends Voyager> (RouterContext context, T voyager) → void - allows programmatic path specification
-
VoyagerFactory<
T extends Voyager> (AbstractRouteContext abstractContext, Map< String, dynamic> config) → T
Exceptions / Errors
- RouteNotFoundException
- Thrown if a given route is not found.