routemaster

Important: this release has some major breaking changes with how Routemaster interacts with the system back button on Android and web from v0.9.

• Minimum supported Flutter version is now 2.5.0.

• Breaking change: by default, the Android system back button now navigates backwards chronologically, instead of just popping the navigation stack.

• Breaking change: by default, tabs no longer add an entry to the web history stack. This means the browser back button will not navigate between tabs. To use the previous behavior, specify backBehavior: TabBackBehavior.history in the tab page's constructor.

• Added: history property on Routemaster for chronological history navigation, for example Routemaster.of(context).history.back().

• Added: popUntil to pop multiple times with a predicate.

• Added: TransitionPage and TransitionBuilderPage to make it much easier to customize page push and pop animations.

• Added: private routes - route segments that start with an underscore are not shown to the user. For example /sign-up/_stepTwo will be displayed as /sign-up in the address bar, and the user can not navigate to it by URL.

• Added: StackPage for navigation stacks without indexed pages

• Added: navigatorKey property to RoutemasterDelegate and PageStackNavigator. Using a GlobalKey<NavigatorState> can provide access to navigator functionality and the current context.

• Added: length property to PageStack to find out how many pages the stack will generate.

• Added: PageStackNavigator.builder constructor for advanced scenarios to filter which pages are shown in the navigator.

• Fixed: an issue with getting RouteData.of(context) in some advanced circumstances.

• Fixed: when navigating to a relative route, uses the current context's path as the base, instead of the router's current path.

• Added: length property to PageStack to find out how many pages the stack will generate.

• Added: PageStackNavigator.builder constructor for advanced scenarios to filter which pages are shown in the navigator.

• Fixed: an issue with getting RouteData.of(context) in some advanced circumstances.

• Breaking change: renamed and refactored some core Routemaster objects. Unlikely to affect anyone unless you're making custom stateful pages.

• Fixes a bug with forward history navigation.

Important: this release has some major breaking changes with how Routemaster
interacts with the system back button on Android and web.

• Minimum supported Flutter version is now 2.5.0.

• Breaking change: by default, the Android system back button now navigates
  backwards chronologically, instead of just popping the navigation stack.

• Breaking change: by default, tabs no longer add an entry to the web history
  stack. This means the browser back button will not navigate between tabs.
  To use the previous behavior, specify backBehavior: TabBackBehavior.history in
  the tab page's constructor.

• Added: history property on Routemaster for chronological history navigation,
  for example Routemaster.of(context).history.back().

• Added: popUntil to pop multiple times with a predicate.

• Fixed: when navigating to a relative route, use the current context's path as
  the base, instead of the router's current path.

• Added: TransitionPage and TransitionBuilderPage to make it much easier to customize page push and pop animations.

• Added: private routes - route segments that start with an underscore are not shown to the user. For example /sign-up/_stepTwo will be displayed as /sign-up in the address bar, and the user can not navigate to it by URL.

• Fixed: an issue where pages would not receive query parameters

• Fixed: an issue where pages were incorrectly rebuilding, causing state such as the active tab to reset
• Fixed: you can now use the ternary operator in page builders without having to do extra casts

• Fixed: incorrect path reference in file (thanks to Thomas Frantz for PR)
  

• Fixed: navigating to an unknown page on startup could throw an exception

• Fixed: issue where routesBuilder could be called outside the build phase.

• Breaking change: PageStackNavigator no longer automatically provides a HeroController - to use heroes, wrap the navigator in a HeroControllerScope
• Breaking change: refactored PageWrapper and StatefulPage (this is unlikely to affect you)
• Added a new property to get the current route: Routemaster.of(context).currentRoute
• Added documentation to all classes, properties and methods
• Fixed: RouteData.of(context) sometimes throwing when navigating away from a page
• Fixed: issue with rebuilding routes when RoutemasterDelegate is recreated
• Fixed: widgets rebuilding when RoutemasterDelegate is recreated

• Breaking change: Guard properties have been renamed: validate is now canNavigate and onValidationFailed is now onNavigationFailed
• Breaking change: removed abstract RouteConfig class; to create custom routing maps, inherit from RouteMap
• Deprecation: StackNavigator has been renamed PageStackNavigator
• Added NotFound return page type
• Added ability to customise the top-level navigator with RoutemasterDelegate.builder
• Added ability to use tabs with a custom page type
• Fixed replace() not working with hashes on web
• Fixed path URL strategy not working when it's set outside Routemaster
• Fixed tabs creating a redirect loop on web
• Note: Use of Guard is no longer recommended - use standard if statements and NotFound or Redirect

• Fixed pathTemplate property on RouteData

• Fixed paths using backslashes on Windows

• Breaking change: RouteData.path no longer returns the full path with query string, to match Dart's Uri object. Use RouteData.toString() or RouteData.fullPath for the entire path including query string.
• Breaking change: Guard now takes a builder method instead of a child property
• Added support for return values via pop('Result')
• Added support for getting the Route object when pushing a new path
• Fixed an issue where subpages wouldn't push on top of a tab page
• Fixed an issue where query string values were lost after using the back button

• Support for absolute paths in tab child routes

• Fixed building against Flutter master branch

• Added SafeArea to default 404 page
• Fixed an issue navigating with relative paths and query strings
• Fixed an issue where the controller didn't update when tab length changed

• Fixed an issue where the root navigator would rebuild unnecessarily
• Added more useful assert errors
• Added default body for RoutemasterObserver.didChangeRoute so you're not forced to override it

• Added support for RoutemasterObserver in RoutemasterDelegate
• Added support for NavigatorObserver in StackNavigator
• Renamed tabController to controller

• Bug fix for reusing stacks in multiple navigators

• Added StackNavigator to simplify API
• Support for non-hash URLs on web - Routemaster.setPathUrlStrategy()
• Support for hero animations in nested navigators

• Re-work guards and redirects to make API simpler

• API hopefully becoming stable
• More flexible and customisable router config
• Support for "404" pages via onUnknownRoute
• Added Dashazon example, see example/book_store/

• Hugely improved and totally refactored API
• Null safety

• Initial first version