routeIf function

Future<void> routeIf(
  1. bool condition,
  2. dynamic routeName, {
  3. dynamic data,
  4. Map<String, dynamic>? queryParameters,
  5. NavigationType navigationType = NavigationType.push,
  6. dynamic result,
  7. bool removeUntilPredicate(
    1. Route route
    )?,
  8. TransitionType? transitionType,
  9. @Deprecated('Use transitionType instead to specify the page transition type.\nE.g. TransitionType.fadeIn()') PageTransitionType? pageTransitionType,
  10. @Deprecated('Use transitionType instead to specify the page transition type.\nE.g. TransitionType.fadeIn()') PageTransitionSettings? pageTransitionSettings,
  11. dynamic onPop(
    1. dynamic value
    )?,
})

Navigate to a new route if a condition is met. If the condition is false, the route will not be navigated to.

Implementation

Future<void> routeIf(
  bool condition,
  dynamic routeName, {
  dynamic data,
  Map<String, dynamic>? queryParameters,
  NavigationType navigationType = NavigationType.push,
  dynamic result,
  bool Function(Route<dynamic> route)? removeUntilPredicate,
  TransitionType? transitionType,
  @Deprecated(
    'Use transitionType instead to specify the page transition type.\nE.g. TransitionType.fadeIn()',
  )
  PageTransitionType? pageTransitionType,
  @Deprecated(
    'Use transitionType instead to specify the page transition type.\nE.g. TransitionType.fadeIn()',
  )
  PageTransitionSettings? pageTransitionSettings,
  Function(dynamic value)? onPop,
}) async {
  if (!condition) return;
  await routeTo(
    routeName,
    data: data,
    queryParameters: queryParameters,
    navigationType: navigationType,
    result: result,
    removeUntilPredicate: removeUntilPredicate,
    transitionType: transitionType,
    // ignore: deprecated_member_use_from_same_package
    pageTransitionSettings: pageTransitionSettings,
    // ignore: deprecated_member_use_from_same_package
    pageTransitionType: pageTransitionType,
    onPop: onPop,
  );
}