+Add shouldPreserve to RouteState

Author: robelator

lib/src/route_controller.dart

@@ -58,7 +58,7 @@ class RouteController {
     required List<RouteBuilder> builders,
   }) {
     _builderMap = {
-      for (var builder in builders) builder.routeState.path: builder,
+      for (var builder in builders) builder.routeState.uri.path: builder,
     };
 
     platformNavigator.addStateCallback(pushUri);
@@ -125,7 +125,7 @@ class RouteController {
   void _maybeRemoveStaleRoute(RouteState routeState) {
     final builder = _getBuilderByPath(routeState.uri);
     if (builder == null) return;
-    if (!builder.shouldPreserve) {
+    if (!builder.shouldPreserve && !routeState.shouldPreserve) {
       _widgetCache[routeState] = SizedBox.shrink(key: routeState.key);
     }
   }
@@ -235,9 +235,8 @@ class RouteController {
     if (index < 0 || index >= state.routes.length) return false;
 
     _previousRouteForTransition = currentRouteState;
-    _nextAnimationEffect = index < state.index
-        ? backwardAnimationEffect
-        : forwardAnimationEffect;
+    _nextAnimationEffect =
+        index < state.index ? backwardAnimationEffect : forwardAnimationEffect;
 
     final newRoute = state.routes[index];
     addToCache([newRoute]); // Ensure widget exists before navigating.
@@ -377,9 +376,8 @@ class RouteController {
       },
       builder: (context, results) {
         final children = _widgetCache.values.toList();
-        final layerEffects = results.isNotEmpty
-            ? results.map((e) => e.data).first
-            : null;
+        final layerEffects =
+            results.isNotEmpty ? results.map((e) => e.data).first : null;
         return PrioritizedIndexedStack(
           indices: [
             _indexOfRouteState(routeState),
@@ -404,8 +402,8 @@ class RouteController {
   }
 
   static RouteController of(BuildContext context) {
-    final provider = context
-        .dependOnInheritedWidgetOfExactType<RouteControllerProvider>();
+    final provider =
+        context.dependOnInheritedWidgetOfExactType<RouteControllerProvider>();
     if (provider == null) {
       throw FlutterError('No RouteControllerProvider found in context');
     }

lib/src/route_state.dart

@@ -11,16 +11,19 @@
 // ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
 //.title~
 
+import 'package:df_safer_dart/_common.dart';
+
 import '/_common.dart';
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
-class RouteState<TExtra extends Object?> {
+class RouteState<TExtra extends Object?> extends Equatable {
   late final Uri uri;
   final TExtra? extra;
   final bool skipCurrent;
   final AnimationEffect animationEffect;
   final TRouteConditionFn? condition;
+  final bool shouldPreserve;
 
   Key get key => ValueKey(uri.toString());
 
@@ -31,6 +34,7 @@ class RouteState<TExtra extends Object?> {
     this.skipCurrent = true,
     this.animationEffect = const NoEffect(),
     this.condition,
+    this.shouldPreserve = false,
   }) {
     final qp = {...uri.queryParameters, ...?queryParameters};
     this.uri = uri.replace(queryParameters: qp.isNotEmpty ? qp : null);
@@ -43,6 +47,7 @@ class RouteState<TExtra extends Object?> {
     this.skipCurrent = true,
     this.animationEffect = const NoEffect(),
     this.condition,
+    this.shouldPreserve = false,
   }) {
     final uri0 = Uri.parse(pathAndQuery);
     final qp = {...uri0.queryParameters, ...?queryParameters};
@@ -55,15 +60,17 @@ class RouteState<TExtra extends Object?> {
     TExtra? extra,
     bool? skipCurrent,
     AnimationEffect? animationEffect,
-    TRouteConditionFn? condiiton,
+    TRouteConditionFn? condition,
+    bool? shouldPreserve,
   }) {
     return RouteState<TExtra>(
       uri ?? this.uri,
       queryParameters: queryParameters,
       extra: extra ?? this.extra,
       skipCurrent: skipCurrent ?? this.skipCurrent,
       animationEffect: animationEffect ?? this.animationEffect,
-      condition: condition ?? condition,
+      condition: condition ?? this.condition,
+      shouldPreserve: shouldPreserve ?? this.shouldPreserve,
     );
   }
 
@@ -74,16 +81,17 @@ class RouteState<TExtra extends Object?> {
     bool skipCurrent = true,
     bool animationEffect = true,
     bool condition = true,
+    bool shouldPreserve = true,
   }) {
     return RouteState<TExtra>(
       uri ? this.uri : Uri(),
       queryParameters: queryParameters ? this.uri.queryParameters : null,
       extra: extra ? this.extra : null,
       skipCurrent: skipCurrent ? this.skipCurrent : true,
-      animationEffect: animationEffect
-          ? const NoEffect()
-          : this.animationEffect,
+      animationEffect:
+          animationEffect ? const NoEffect() : this.animationEffect,
       condition: condition ? this.condition : null,
+      shouldPreserve: shouldPreserve ? this.shouldPreserve : false,
     );
   }
 
@@ -93,14 +101,5 @@ class RouteState<TExtra extends Object?> {
   bool matchPath(RouteState other) => uri.path == other.uri.path;
 
   @override
-  bool operator ==(Object other) {
-    if (identical(this, other)) return true;
-    if (other is! RouteState) return false;
-    return uri == other.uri && extra == other.extra;
-  }
-
-  String get path => uri.path;
-
-  @override
-  int get hashCode => (RouteState).hashCode ^ uri.hashCode;
+  List<Object?> get props => [uri, extra];
 }

pubspec.yaml

@@ -19,7 +19,7 @@ funding:
 - https://github.com/sponsors/t0mb3rr
 - https://www.buymeacoffee.com/dev_cetera
 description: A lightweight router designed for ease of use and efficient state management. 
-version: 0.5.2
+version: 0.5.3
 topics:
   - router
   - navigation