voyager 0.7.2

voyager: ^0.7.2 copied to clipboard

• VoyagerListView, a widget that allows mapping a list of items onto respective list of paths and then displaying them

• add optional Key constructor parameter to VoyagerWidget and VoyagerStatelessWidget

• ...and we're back to stateful widget by default - while you should use StatelessWidget whenever possible, navigation is causing widget recreation which means recreation of Voyager instance - and that's something we don't want to do.
• generator now supports CupertinoPageRoute that can be specified via additional parameter

generator(routeType: RouterNG.cupertinoRoute)

• VoyagerArgument is available via Provider whenever you navigate with an argument
• ability to dispose resources created with WidgetPlugins via onDispose callback:

output.onDispose(() {
  print("disposing resources");
});

• display information in case dartfmt is missing from your path and you're using code generation tool.

SOME BREAKING CHANGES #

• VoyagerWidget becomes stateless by default. If you want to have stateful behavior, please use VoyagerStatefulWidget
• Dropped Voyager.fromPath method, it was redundant and confusing. Use constructor directly instead.
• It is now recommended to wrap your app with Provider<RouterNG>. By doing this you can ommit passing the router parameter to every VoyagerWidget and thus making widget tree more compact since VoyagerWidget don't have to provide router instance themselves.

Provider<RouterNG>.value(
  value: router,
  child: MaterialApp(
    home: VoyagerWidget(path: initalPath),
    onGenerateRoute: router.generator()
  )
)

• VoyagerWidget has now extra cache parameter, meaning it will use RouterNG's caching internally to resolve Voyager instance faster. Depending on your use case you might want to use this or not. Such Voyager instance has no parent.

The decision to change VoyagerWidget to stateless widget and removal of fromPath method was an inspiration after reading the following articles:

• Splitting Widgets To Methods is A Performance Antipattern - Iiro Krankka
• Flutter: Reducing widgets boilerplate - Remi Rousselet

It's a MUST READ for any Flutter developer.

• update to patched code generator version

• decrease occurences of voyager instance creation

You will be automated, resistance is futile.

BREAKING CHANGES #

• automated widget tests (EXPERIMENTAL)
• removal of deprecated VoyagerProvider, see version 0.2.0 for migration steps (VoyagerProvider will return in a changed form...)
• removal of TypePlugin - it's redundant, omit it in plugins list but still use type in your specs for code generation goodness
• RedirectPlugin, allows mapping virtual paths to existing ones
• ScreenPlugin is now called WidgetPlugin, you also need to change screen to widget in your yaml/json specs

• use dartfmt to make sure generated code is formatted corectly

• package health

• code generation for paths, simply run flutter packages pub run voyager:codegen at the top of your flutter project and behold!

• drop angel_route dependency in favor of abstract_router.dart

• json support

• formatting

• fixes around how VoyagerWidget reacts to hot reload
• improve sample app
• add a sample app gif to README

API DEPRECATION

• VoyagerProvider is being phased out. Internally Voyager will depend on provider more popular within the community.

Migration:

• change VoyagerProvider.of(context) to Provider.of<Voyager>(context)
• change VoyagerProvider.routerOf(context) to Provider.of<RouterNG>(context)

• Package health fixes

• Initial release