zenrouter 0.4.17

zenrouter: ^0.4.17 copied to clipboard

• ZenRouter officially achieved 100% test coverage 🚀
• Docs: Added migration guides from other packages (go_router, auto_route, and Navigator 1.0/2.0)
• Docs: Added recipes for common use cases
• Docs: Added quick links section to make the docs easier to navigate

• Fix: Future already completed bug when pushing the same route with pushOrMoveToTop.

• Feat: Add onUpdate method to RouteTarget for handling in-place route updates when navigating to the same route with different state.
• Feat: Add bindLayout method to StackPath as a convenient alternative for layout registration. (See RouteLayout Guide)

• Breaking Change: Don't allow redirect to return null anymore since it doesn't do anything.
• Feat: Add mustCallSuper to paths getter (Thanks @mrgnhnt96)
• Feat: Add discard parameter to remove method for controlling discarding behavior.
• Fix: Memory leak when pushing RouteQueryParameters in IndexedStackPath.
• Fix: Memory leak when discard route in RouteRedirect.

• Fix: Ensure navigate method is compatible with RouteRedirect.

• Feat: Introduce new StackNavigatable mixin for StackPath to handle custom logic when receiving a navigate command. (Back/Forward button on the browser)
• Fix: navigate clear all history that occurred when pushing a custom layout.

• Feat: Expose stackPath in RouteTarget and expose protected method for developer create custom stackPath.
• Feat: Add onDiscard to handle discarding phase in RouteTarget.

• Chore: Fix analyzer warnings

• Chore: Standardize serialize and deserialize for supported RouteTarget type

• Feat: Introduce new state restoration with RouteRestoration mixin. Support state restoration by default if restorationScopeId is provided in MaterialApp.router and using Coordinator pattern.
• Fix: Resolve bug in recover method where RouteRedirect was ignored.

• Docs: Update README

• Docs: Update README and add screenshots

• Feat: Add RouteQueryParameters mixin for targeted query parameter updates using ValueNotifier.
• Fix: Ensure path is set for RouteTarget when initial IndexedStackPath.
• Fix: Ensure layout is resolve correct if they under deeper stack.
• Refactor: Refactor folder structure and test folder structure to be more organized.

• Feat: New ZenRoute Logo!
• Docs: Improve document and update outdate example

• Feat: Add CoordinatorNavigatorObserver mixin to provide a list of observers for the coordinator's navigator.
• Breaking Change: Complete redesign [RouteLayout] builder to be more flexible and powerful.
  • Deprecate static method RouteLayout.buildPrimitivePath and use buildPath function instead.
  • Add ability to define new [StackPath] using RouteLayout.definePath. You can create custom behavior path builder. (Eg: RecoverableHistoryStack like unrouter)

• Feat: Add transitionStrategy to Coordinator for default stack transition setup
• Fix: Ensure when [Navigator.pop] called sync new stack with [NavigationPath]

• Fix: Ensure [Coordinator.routeDelegate] initialize once
• Improvement: Add [IndexedStackPathBuilder] for improve performance for rendering [IndexedStackPath]

• Breaking Change: Deprecated default constructors for NavigationPath and IndexedStackPath. Use NavigationPath.create/createWith and IndexedStackPath.create/createWith instead.
• Breaking Change: Introduced internalProps to RouteTarget for better deep equality and hash code generation.
• Feat: Added popGuardWith to RouteGuard and redirectWith to RouteRedirect for coordinator-aware mixin logic.
• Feat: Added strict path-coordinator binding support via createWith factories.
• Docs: Added comprehensive Migration Guide.
• Feat: Added routerDelegateWithInitalRoute to Coordinator.
• Feat: Enhanced setInitialRoutePath to correctly handle initial routes vs deep links.

• Add navigate function: A smarter alternative to push that handles browser history restoration by popping to existing routes instead of duplicating them.

• Allow parseRouteFromUri to return Future for implementing deferred import/async route parsing

• Breaking change: Change return of Coordinator.push() from Future<dynamic> to Future<T?>
• Fix NavigationStack rerender page everytime path updated. Resolve #10.
• Feat: Add recover function

• Update activePathIndex to activeIndex in IndexedStackPath
• Update document for detailed, hand-written example of Coordinator pattern

• Expose pop result in Coordinator
• Fix memory leak: Complete route result futures when routes are removed via pushOrMoveToTop
• Fix memory leak: Complete intermediate route futures during RouteRedirect.resolve chain

• Standardize how to access primitive path layout builder
  • Define using definePrimitivePath
  • Build using buildPrimitivePath

• BREAKING: Rename activeHostPaths to activeLayoutPaths to reflect correct concept.

• Update homepage link

• Fix broken document link by update it to github link

0.1.1 #

• Fix broken document link

• Initial release of ZenRouter.
• Unified Navigator 1.0 and 2.0 support.
• Coordinator pattern for centralized navigation logic.
• Support for both Declarative and Imperative navigation paradigms.
• Route mixins: RouteGuard, RouteRedirect, RouteDeepLink.
• Optimized Myers diff algorithm for efficient stack updates.
• Type-safe routing with RouteUnique.