nuvigator

2.0 Major Beta Release 🎉

This beta release includes the so-awaited support for Sound Null Safety and the removal of the Legacy API

What's Changed

• Removal of Nuvigator Legacy API by @leoiacovini in #101
• Add support for sound null safety by @leoiacovini in #102

Full Changelog: v1.8.0...v2.0.0-beta.3

• Improve error message when a NuRoute is registered twice

• Add option to get registered routes after NuRouter initialization when overriding the lazyRouteRegister option in NuRouter

• Change the NuRouter.onError to handle any thrown object (including Exception)

What's Changed

• Mob plat/bump flutter 2.10 by @RaqG in #98
• Add 1.8.0-beta.0 changelog by @raapperez in #99
• Bump analyzer due to flutter 3.0.2 by @renatoaugustofranca in #100

New Contributors

• @RaqG made their first contribution in #98
• @raapperez made their first contribution in #99
• @renatoaugustofranca made their first contribution in #100

Full Changelog: v1.7.0-beta.0...v1.8.0

• [FIX] Revert changes from 1.6.1 due to some unexpected behaviors found

• [FIX] Fix re-renders due to other state changes when Nuvigator.shouldRebuild returns false

• [ENHANCEMENT] Add Nuvigator.shouldRebuild property for controlling when a Nuvigator should be rebuild.

• [NEW] Add NuRoute.metaData to be used as a metadata dictionary for NuRoutes
• [NEW] Add NuRouter.buildWrapper that can be used to wrap the builder function of the registered NuRoutes

• [FIX] Fix error when disposing a Nuvigator that was rendered in a Route that does not implement NuvigatorPageRoute

• [NEW] Add NuvigatorPageRoute.nestedNuvigator property that is going to link to the nested Nuvigator instance that is being rendered by this Route
• [NEW] Add NuvigatorState.presenterRoute that will link to the Parent Route that is rendering this Nested Nuvigator
• [NEW] Add NuvigatorPageRoute.of(context) to retrieve the closest NuvigatorPageRoute in the Context

• [ENHANCEMENT] Improvements to all *Named method in Nuvigator
• [NEW] Add NuRoute.withPath to be used as a RoutePredicate matcher
• [NEW] Add new methods in Nuvigator: replaceNamed, removeByPredicate and popAndPush
• [NEW] Adds key, inheritableObservers, debug, observers, shouldPopRoot arguments to the Nuvigator.routes factory
• [NEW] Adds the optional result argument to the Nuvigator.open method

• [FIX] Revert support for List Query Arguments in the legacy API, and preserve previous typings

• [FIX] Make Nuvigator.open propagate all options to parent when the route is not found at the current level
• [FIX] Properly support List Query Arguments in DeepLinks, instead of picking a random one

• Improve error message when a NuRoute is registered twice
• Improve error handling on empty NuRouters
• Add option to get registered routes after NuRouter initialization when overriding the lazyRouteRegister option in NuRouter
• [BREAKING] Change the NuRouter.onError to handle any thrown object (including Exception)
  • Type of the NuRouter.onError function changed from Exception to Object
• Bump dependencies versions and make code adjustments to support usage on non nullable projects (does not include non-nullable in Nuvigator itself)

• Bump dependencies versions and make code adjustments to support non nullable

• Add the ScreenTypeBuilder class to allow the definition and creation of ScreenTypes in an ad-hoc manner
• Add the screenType parameter to the NuvigatorState.open method, allowing to override the ScreenType of a defined Route to be opened

• First stable release with NEXT API (check past beta changelog entries for details)

• Add option in NuRouter to retry the initialization of the Router when it fails

• Add option in NuRouter to provide an error handling function when the Router initialization fails

• Fix extra arguments passing on the [NuvigatorState.open] method

• Fix open method in order to transport params through actions

• Fix the NuRouteSettings copy and fallback methods that were not considering the settings property

• Fix the NuRouterLoader to re-instantiate the nuvigator only if the router change

• Fix to use the screenType when the fallback one is not provided

• Improvements on next API typings
• Improvements to next generator

• Add awaitForInit option in the NuRouter to configure if it should support async initialization
• Fix router property name on NuRoute
• Make loadingWidget a getter method

• Add support from Navigation coming from Native side on Next API
  • INuRouter.getRoute now accepts an optional isFromNative option
  • NuvigatorState.open now accepts an optional isFromNative option
• Remove default screenType from Nuvigator constructor

• Fixed asserts on Nuvigator
• Add improved error message when a ScreenRoute is rendered without a ScreenType specified

• Introduction of a new dynamic API (aka: next), more info can be found at it's own documentation
  • DeepLinks and RouteNames where unified under paths
  • New dynamic approach to define Routes and Routers
  • More info can be found at here
• initialDeepLink and initialRoute have better error reporting and a more precise behavior.
  • Just the explicitly provided initialRoute is going to be used to find the Route.
• Nuvigator now relies on a interface type INuRouter instead of a concrete specific implementation
• onScreenNotFound method was removed
• Introduction of NuvigatorState.open in favor of .openDeepLink. This new method supports nested deepLink navigation.
• Old API can be considered deprecated from now on. Prefer using the next API on new projects.

• Fix conflict between Nuvigator and NuvigatorInner key

• Fix problems caused by bump in analyzer dependency

• Update README
• Update pubspec.yaml to support analyzer up to version 0.41.0

• [BREAKING] Rename classes to avoid conflicts with Flutter 1.22 Router Widget
  • Router was renamed to NuRouter
  • The NuRouter annotation was renamed to nuRouter const or customNuRouter function

• Fix NPE exception when a old instance of router tries calling some methods on it's nuvigator

• Fix a NavigationObserver error when the nuvigator is updated. Now we are reloading the inheritableObservers and StateTracker when has an update.

• Add support for typed screen arguments on deep links. In addition to String, we now support int, double, bool, and DateTime.

• Update ReCase version support to '>= 2.0.0 <3.1.0'

• Updates the codebase to flutter 1.17 (stable) version

• Support query parameters with dashes by converting them to camelCase

• Downgrade the analyzer dependency to '>=0.38.5 <0.40.0'

• Fix the Nuvigator.of(context) to start the search at the last state instead of root

• Make initialDeepLink work passing arguments to destination route

• Allow to pass an initialDeepLink
• Add new option to pop SystemNavigator on last screen of the Root Router

• [BREAKING] API Simplifications/Changes.
  • Removal of ScreenWidget and related generated classes.
  • Removal of FlowRoute, now you can use the default ScreenRoute and pass the Nuvigator to the builder function.
  • Removal of GlobalRouter, every Router had it's capabilities incorporated, you can override previous GlobalRouter properties directly in your topmost Router class, and pass it directly to the Nuvigator.
  • Removal of Nuvigator initialArgs auto-passing, now you should explicitly provide the arguments required to the nested nuvigator. The suggestion is to pass it to the Router constructor.
  • Removal of FlowRouters.
  • Nested Nuvigators will not have it's router exposed by the parent anymore.
  • Use extension methods to navigation methods in the Router. Instead of ExampleNavigation.of(context).toRoute() use Router.of<ExampleRouter>(context).toExampleRoute().
  • Use of extension methods to screensMap and routers generator. Instead of passing this to the function, just call the private getter _$screensMap and _$routers in the Router class.
  • Unify Router and BaseRouter, instead of extending BaseRouter you should extend Router directly.
  • Rename getDeepLinkPrefix to deepLinkPrefix.
  • initialRoute is now a required argument to Nuvigator.
• [IMPORTANT] Router instances should be unique per Nuvigator. The same Router instance SHOULD NOT be shared by different Nuvigator (we advise to create new instances together with the Nuvigator).
• A bug was fixed were the maybePop method was not consistent with the Android back button behavior. Now the expected behavior is to always pop the Route of the active Nuvigator.
• Nuvigator now keeps track of it's Route stack.
• Added debug flag to Nuvigator to log all route transitions/changes.
• Observers management was moved into the state lifecycle to ensure that inheritableObservers are always going to be considered.
• [BUMP] Updates to Flutter 1.12.1, resolves some deprecation warnings.
• A toMap getter was added to Args* classes to serialize them into Map<String, Object>.
• Added new mixin NuvigatorRoute that should be incorporated by PageRoutes used in custom ScreenTypes. While this mixin is optional, it will guarantee the correct behavior of Android's back button and also make nested Nuvigators Routes present AppBar back buttons correctly based in the overall App state, and not only by the current Nuvigator. (The provided screensTypes Material and Cupertino have already been update to include this new Mixin).
• Improvement of some error messages that could be misleading or produce unexpected error.