auto_route_generator 9.0.0

AutoRoute is a declarative routing solution, where everything needed for navigation is automatically generated for you.

9.0.0 [Breaking Changes]

• BREAKING CHANGE: No Router class will be generated anymore. Instead, you extend RootStackRouter from the auto_route package.
• BREAKING CHANGE: Providing return types inside @RoutePage<Type>() is no longer needed. you just provide the type as you push the page.
• BREAKING CHANGE: Providing a global route is now done by overriding the guards property inside the router. implementing AutoRouteGuard is no longer supported.
• BREAKING CHANGE: AutoRouterConfig.module is removed as it's no longer needed. PageRouteInfos are now self-contained.

For more info read the complete migration guide Migrating to v9

• FIX: Fix Aliased types are not generated correctly.
• FEAT: You can now create empty shell routes like follows:

     final BooksTab = EmptyShellRoute('BooksTab');
     context.push(BooksTab());
  

8.1.0

• FEAT: add url#fragment support.
• CHORE: update auto_route_generator dependencies

8.0.0

• FEAT: AutoTabsRouter will now use the declared routes if AutoTabsRouter.routes is not provided, if of any of the tabs has required parameters it will throw an error.
• BREAKING CHANGE: deep-links with no host e.g scheme://page/sub-page are no longer automatically handled, flutter's deep-link handler will treat [page] as host so we end up with [/sub-page] as a path which of course not going to match. if your deep-links are hostless you'll need to handle them manually inside deepLinkBuilder.

7.3.2

• FIX: Build Runner Efficiency Warning #1737

7.3.1

• DOCS: Add public Api docs to auto_route_generator.
• REFACTOR: Update analyzer constrains to support up to version 7.0.0

7.3.0

• REFACTOR: generated routes are now alphabetically sorted.
• FEAT: add option to pass custom ignore_for_file rules to the generated file.

7.2.0

• FEAT: Add basic support to dart records.
• FIX: encoded path segments are not decoded in RouteMatch.pathParams
• FIX: encoded browser path is checked against a decoded matched path when deciding whether to replace route #1637

7.1.2

• FIX: AutoRouteConfig.module() doesn't generate part of file correctly. #1626.

7.1.1

• REFACTOR: change module extension from .module.dart to .gm.dart.
• update dart sdk constrains to ">=2.17.0 <4.0.0"

7.1.0

• FEAT: add more flexible multi package support.

7.0.0

• Sync with auto_route version

6.2.0

• Sync with auto_route version

ChangeLog

[6.1.0]

• Change navigatorKey param to super declaration to avoid material.dart import

[6.0.3]

• Fix Inherited params not working? #1443

[6.0.2]

• Add option to used cached_builds for more optimized generation

[6.0.1]

• update CodeBuilder to 4.4.0

[6.0.0]

• Sync with auto_route version

[6.0.0-rc-1]

• Support dart_style 2.2.5

[6.0.0-rc] Breaking

make sure you check the Migration guide

• AutoRoute now takes a PageInfo object from the generated routes instead of Type
• Introduce @RoutePage() annotation to annotate routable widgets
• Routes are defined in the body of the router class instead of inside the annotation
• Remove replace @MaterialAutoRouter,@CupertinoAutoRouter ...etc with @AutoRouterConfig annotation
• Remove EmptyRouterPage & EmptyRouterScreen
• "initial" flag is removed now, use "/" for initial routes or empty path "" for nested-initial routes.
• Passing route guards is also changed now, instead of passing guards as types you now pass instances.
• Add title builder for AutoRoute(title: (ctx,data){})
• Docs are changed to reflect the new changes so make sure you re-read them.

---

[5.0.3]

• Change analyzer constrains to support up to version 6.0.0
• Merge #1236
• Merge add opaque property to AdaptiveRoute #1224
• Merge readme.md file updates

[5.0.2]

• Allow analyzer version 4.4.6

[5.0.1]

• Add ignorePagelessRoutes and ignoreChildRoutes property to AutoLeadingButton
• Add builder property to AutoLeadingButton
• Fix deferredLoading and AutoRouteWrapper are not working together

[5.0.0]

• Add deferred loading support for web to enable code splitting for routes [By Garzas]
• Move EmptyRouterScreen and EmptyRouterPage to a separate file to avoid import conflict when using deferred loading.
• Fix a bug in Navigation History
• Add License file to root package
• Fix TabController dispose issue in AutoTabsRouter.tabBar
• Add neglectWhen call back to ignore reporting location to engine
• Remove universal_html dependency and implement own conditional html import

[4.2.1]

• Fix part builder doesn't work with analyzer 4.3.0+

[4.2.0]

• Add generate-time check for unresolvable path params
• You can now access inherited path params using @pathParam annotation

[4.0.0] (Breaking changes)

• Refactor AutoRedirectGuard [Breaking Change]
• Add AutoRouteAwareStateMixin to minimize boilerplate for AutoRouteAware states
• Add NoShadowCupertinoTransitionsBuilder to remove unwanted shadow in nested cupertino routes
• Add PageView support to AutoTabsRouter
• Add TabBar support to AutoTabsRouter
• Add custom builder support to AutoTabsRouter
• Remove AutoTabsRouter.declarative implementation (replaced with builder) [Breaking Change]
• AutoRouter.declarative routes now accepts a PendingRoutesHandler instead of context [Breaking Change]
• Fix wrapped routes are rebuilt everytime the stack changes
• Fix query params are not updated in Tab-Routes
• Add router.activeGuardObserver to access active guards. e.g to implement loading indicator
• Fix initial route is not showing when nested router is rebuilt
• Replace AutoBackButton with AutoLeadingButton to support drawer and close icons

[3.2.1]

• Merge some readme file typo-fixes
• Add @optionalTypeArgs to AutoRoute annotations
• Fix AdaptiveRoute issue with CustomRoute
• Change analyzer constrains to include version 3.0.0
• Add notify flag to removeWhere method inside of StackRouter

[3.2.0]

• Merge fix conform new API in Flutter 2.6
• Fix declarative routes update issue
• Add Router tests

[3.1.0]

• Prefer previous-current route index as new current index when updating tab routes #797
• Improve native navigation history
• Use browser history as navigation history in web
• Fix path/query params not updating issue #809
• Fix generic nullable types are generated as non-nullables #811
• Override toString method inside of generated arg classes [FR] #820
• Support redirect paths with path params [FR] #818
• Fix replace/replaceNamed/replaceAll do not replace current url in browser #781

[3.0.1]

• Fix conflict with source_gen:combining_builder by using .gr.dart instead of .g.dart

[3.0.0]

• Add option to use part builder .g.dart
• Add option to pass const meta data from annotation to consumed route data.
• Show better error message when router can not navigate to given route.
• ancestor router can now push directly to nested router if it's already in stack.
• Add navigateBack functionality
• Add AutoRedirectRoute which reevaluates guarded routes that's already in stack

[2.4.1]

• Fix pushing same route not rebuilding stack; effecting #717 #710
• Fix dialogs/bottom sheets don't play nicely with auto_route when using nested routers
• Add option to push an un-routable widgets to StackRouters
• Add a comment containing the widget type reference to generated routes for easy source jumping

[2.4.0]

• Fix url updates delay
• Fix navigate does not update url
• Add auto_route_information_provider.dart to fix infinite browser back button when using url redirects
• optimize routes rebuild -> only rebuild if route data changes
• Change routers are now not ( Watched ) by default to reduce rebuilds [ may Break]
• Add optional homeIndex property to AutoTabsRouter to make sure we always pop from home tab
• Change AutoBackButton to use StackRouterScope instead of RouterScope

[2.3.2]

• Merge fix(generator): Bool opt type as num #688
• Fix nested back gesture issue #686

[2.1.0] Breaking changes!

• adds void type to PageRouteInfo<void> to become strong-mode compliant

[2.1.0] Breaking changes!

• AutoRouteGuard no longer returns a future
• Remove onInitialRoutes from AutoRouterDelegate. [Breaking]
• Rename RoutingControllerScope to RouterScope. [Breaking]
• Expose provided navigatorObservers in RouterScope
• Route name is now default page key with option to use path as key.
• Add onNavigate callback function to AutoRouterDelegate
• Add onNavigate all back to AutoRouter.declarative
• Add declarative option to AutoTabsRouter

[2.0.1] Breaking changes!

• OnPopRoute includes a results object now. [Breaking]
• Required queryParams to either be nullable or have a default value

[2.0.0] Breaking changes!

breaking changes

• Remove usesTabsRouter property from AutoRoute as it's no longer needed.
• onGenerateRoutes is now shortened to just routes and initial routes are no longer pass
• Legacy generator is completely dropped now.
• Remove all legacy generator related flags.
• navigatorObservers is not a callback function that returns a list of observers

enhancements

• Bring back the good old await for pop results feature.
• The root AutoRouterDelegate can now be declarative.
• Push, replace and navigate will now bubble up if they can't be handled by the router they're called from.
• Enhance the navigate function to behave like navigating from the browser's bar.
• Add new methods to navigate by path pushNamed, replaceNamed and navigateNamed.
• Add AutoBackButton to handle nested routers popping with ease.
• Add some helper/shortcut methods to context extension, pushRoute, replaceRoute, navigateTo and popRoute.
• Add some helper methods to the RoutingController like popTop, topRoute and more.
• Pages will rebuild when an ancestor router updates if you depend on it.
• Add Auto RedirectRoute generation for Routes with none initial paths that's marked as initial.
• Add AutoRouteObserver to add tabs observing to the native observer.
• NavigatorObservers are now passed through a builder so nested navigators can inherit them.
• Add HeroControllerScope to nested AutoRouters
• Pomp up code_builder version to 4.0.0 and build_runner to 2.0.1
• Fix #458, #456 #421 and #453
• Minor fixes and enhancements

[1.0.2]

• Pomp up versions of build, build_runner, dart_style and source_gen
• Using pathParam annotation is not more flexible and has less constrains
• Remove dart:io import to include (web) as a supported platform
• other fixes

[1.0.1]

• Fix Stack overflow in RootStackRouter popUntilRoot() #401
• Fix path parameters are assigned an undefined var when alias is different than param name.

[1.0.0]

• Migrate to null-safety
• Add option to pass restoration id
• Add option to specify the root navigator background color

[1.0.0-beta.11]

• Fix building PageRouteInfo from match does not respect default values

[1.0.0-beta.10]

• Fix generic parameters crash the generator
• Add support for array type query params

[1.0.0-beta.8]

• Add support for null-Safety to generated code.
• Fix pop issues
• Add popUntil, popUntilRoot and popUntilRouteWithName helper functions to StackRouter
• Minor fixes

[1.0.0-beta.7]

• Fix onRoutePop not called in declarative router #310
• Fix App reloads after pressing browser's back button #309
• Fix TabsRouter not displaying current route when pressing the browser's back button
• Add pop until method to StackRouter
• Prefix parent routes are now included if includePrefixMatches is true
• Add RouteMatcher tests
• Minor improvements

[1.0.0-beta.6]

• Fix reload issue when pressing the browser's back button #309
• Fix onPopRoute is not called in declarative Router #310
• Include empty paths as prefix-matched paths when deep-linking.
• Remove unnecessary dependencies
• Some minor improvements and code refactor

[1.0.0-beta.5]

• Refactor some code
• Update readme file

[1.0.0-beta.4]

• Fix page can not be used for multiple routes
• Add duplicate route-names check in generator.

[1.0.0-beta.2]

• Add lazyLoad option to AutoTabsRouter
• Replace AutoRouterConfig with an implementation of StackRouter
• Root delegate is now lazyLoaded

[1.0.0-beta.1] Breaking Changes!

• Add TabsAutoRouter
• Refactor some code

[1.0.0-beta] Breaking Changes!

• Rebuild auto_route to work with Navigator 2.0

---

[0.6.10]

• Restrict analyzer version to ">=0.40.0 <2.0.0"

[0.6.9]

• Fix generator error running flutter version 1.22
• Fix bar-url not updated in flutter version 1.22

[0.6.8]

• Restrict min analyzer version to 0.39.14
• Restrict min build_runner version to 1.10.1

[0.6.7]

• Fix linter warnings in generated file

[0.6.6]

• Fix generator error when using 'void' as route return type #168

[0.6.5]

• Downgrade path package to >= 1.6.4 to solve conflict with flutter_test
• Clean up auto_route index file

[0.6.4]

• Add usage of const constructors when possible
• Fix material package is only imported if needed
• Fix spelling mistakes in changeLog

[0.6.3]

• Fix relative imports issue on windows
• Fix private screen parameters break generated file

[0.6.2] Breaking Change

• Fix deep linking issue for nested routes
• Change ExtendedNavigator to wrap the native navigator instead of extending it
• Change generated class applies to most of effective dart rules including preferring relative imports
• Change initial route placeholder color to white
• Add extension to BuildContext to easily access the navigator
• Remove NestedNavigator, ExtendedNavigator can be used directly as a nested navigator
• Rename some properties and deprecate their older names
• Remove ExtendedNavigator.ofRouter method
• Minor fixes and enhancements

[0.6.0] Breaking Change

• Change the way routes are declared from class fields to a static list
• Add support for path & query parameters
• Add support for path wildcards
• Add support for nested routes
• Add support for generic result types
• Add get ExtendedNavigator by name feature
• Merge fix for adaptive route web support issue
• Change generating arguments holder for single parameter routes is not optional anymore
• Minor fixes and enhancements

[0.5.0]

• Add support for Complex function types & typeDef as Route parameters

[0.4.10] Skip

[0.4.9] Breaking Changes

• Change generate routes list is no longer optional
• Change Routes.all returns a set instead of List
• Add Route prefix option to AutoRouter
• remove useLeadingSlashes flag from AutoRouter

[0.4.8]

• Change PageRouteBuilder context arg name from ctx to context
• Fix args declaration is generated even if there's no routes with args

[0.4.7]

• Fix non-core dart types aren't imported

[0.4.6] Breaking Change

• Add AdaptiveAutoRouter and AdaptiveRoute for native platforms
• Change using leading slashes is now options
• Change wrappedRoute is now a function that takes in build context
• Fix calling nested route returns null after popping parent route
• Fix initial route ignore custom transitions
• Add ability to name routes class

[0.4.5]

• Fix @unknownRoute generates error

[0.4.4]

• Change generating arguments holder for single parameter routes is now optional
• Fix android soft back button always pops root navigator

[0.4.3] Breaking Changes

• Add ability to pass initial route arguments to ExtendedNavigator
• Change single route parameters will have argument holder classes too as requested
• Fix ExtendedNavigator.ofRouter

[0.4.0] Breaking Changes

• Change using ExtendedNavigator instead of the native Navigator
• Fix initial route does not go through guards
• Change generated router class is no longer static
• Change routes are generated in their own class now "Routers"
• Add option to generate navigation helper methods extension
• Update README file

[0.3.2]

• Fix generic arguments are not imported.

[0.3.1]

• Fix Compilation Fails in flutter 1.15.+
• Fix third party imports src instead of library
• Fix guardedRoutes is generated even if it's empty
• Add support for custom unknown route screen
• upgrade analyzer min restrain to 0.39.2

[0.3.0] Breaking Changes!

• Add global route customization Use MaterialAutoRouter, CupertinoAutoRouter or CustomAutoRouter instead of AutoRouter
• Navigator key is now accessed by calling Router.navigator.key instead of Router.navigatorKey.
• Add Route guards
• Add optional returnType param in all AutoRoute types.
• Remove generate Navigator Key option.
• Fix generate error when using dynamic vars in route widget constructors

[0.2.2]

• Add option to generate a list with all route names
• change generating navigator key is now optional
• Fix prevent importing system library files
• Change generated route path name are now Kabab cased (url-friendly)
• Add ability to use custom path names in all route types
• Update README file

[0.2.1+3]

• fix custom route not generating custom properties

[0.2.1+2]

• fix @required is missing in arguments holder class

[0.2.1+1]

• fix dependency conflict

[0.2.1]

• add Route Wrapper
• add initial flag as a property in all route types
• change prefix const route names with class name.
• add fullscreenDialog property to @CustomRoute()

[0.2.0]

Breaking Changes!

• change to using a single config file instead of annotating the actual widget class due to performance issues.
• add @MaterialRoute(), @CupertinoRoute() and @CustomRoute() annotations
• remove @AutoRoute() annotation and add @AutoRouter()
• handle required parameters.
• add navigating with a global navigator key [without context].
• support nested navigators.

[0.1.3]

• fix more dependencies resolving conflict.

[0.1.2]

• fix dependencies resolving conflict.

[0.1.1]

• code formatting.

[0.1.0]

• initial release.