RRouterBasic class

Constructors

RRouterBasic({ErrorPage? errorPage, bool isUseNavigator2 = false, List<RouteInterceptor>? interceptor, bool isDebugMode = true, PageBuilder? pageBuilder, PopHome? popHome, RRouterParamsConvert? convert})

Properties

context → BuildContext

no setter

convert → RRouterParamsConvert

no setter

delegate → RRouterDelegate

no setter

hashCode → int

The hash code for this object.

no setter, inherited

informationParser → RRouterInformationParser

no setter

isDebugMode ↔ bool

getter/setter pair

isUseNavigator2 ↔ bool

getter/setter pair

navigator → NavigatorState

no setter

observer → NavigatorObserver

no setter

overlayContext → BuildContext?

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addComplete() → void

When you add Route complete ,you should use it

addInterceptor(RouteInterceptor interceptor) → RRouterBasic

add interceptor

addInterceptors(List<RouteInterceptor> interceptors) → RRouterBasic

add interceptors

addObserver(NavigatorObserver observer) → RRouterBasic

add route observer

addObservers(Iterable<NavigatorObserver> observers) → RRouterBasic

add route observers

addRoute(NavigatorRoute route, {bool? isReplaceRouter}) → RRouterBasic

add Route

addRoutes(Iterable<NavigatorRoute> routes) → RRouterBasic

add Routes

canPop() → bool

Whether the navigator can be popped.

formatPath(String path, {Map<String, dynamic>? pathParams, Map<String, dynamic>? queryParams}) → String

if you has query params or path Params,path format.

isMatchPath(String registerPath, String path) → bool

match path

maybePop<T extends Object?>([T? result]) → Future<bool>

Consults the current route's Route.willPop method, and acts accordingly, potentially popping the route as a result; returns whether the pop request should be considered handled.

navigateTo<T extends Object?, TO extends Object?>(String path, {dynamic body, bool? replace, bool? clearTrace, bool? isSingleTop, TO? result, PageTransitionsBuilder? pageTransitions}) → Future

Navigate to Route path page path body page require arguments replace if ture will replace current page to navigate new page. clearTrace if ture will clear all page to navigate new page. isSingleTop if ture will only path is not current path navigate. result went replace is true, this will able. pageTransitions you navigate transition , if null will use default page transitions builder.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pop<T extends Object?>([T? result]) → dynamic

Pop the top-most route off the navigator.

runRoute(String path, dynamic body) → Future<WidgetBuilder?>

run route method

setDebugMode(bool isDebug) → RRouterBasic

Debug Mode

setDefaultTransitionBuilder(PageTransitionsBuilder pageTransitionsBuilder) → RRouterBasic

default transition builder

setErrorPage(ErrorPage errorPage) → RRouterBasic

set Error Page

setPageBuilder(PageBuilder pageBuilder) → RRouterBasic

set default page builder

setParamsConvert(RRouterParamsConvert convert) → RRouterBasic

set Params Convert

setPathStrategy(bool isUsePath) → RRouterBasic

path strategy mode

setPopHome(PopHome popHome) → RRouterBasic

set pop home method

showAboutDialog({String? applicationName, String? applicationVersion, Widget? applicationIcon, String? applicationLegalese, List<Widget>? children, bool useRootNavigator = true, RouteSettings? routeSettings}) → void

showCupertinoDialog({required WidgetBuilder builder, String? barrierLabel, bool barrierDismissible = false, RouteSettings? routeSettings, bool useSafeArea = true}) → Future

showCupertinoModalPopup({required WidgetBuilder builder, ImageFilter? filter, Color barrierColor = kCupertinoModalBarrierColor, bool barrierDismissible = true, bool useRootNavigator = true, bool semanticsDismissible = false, RouteSettings? routeSettings}) → Future

showDatePicker({required DateTime initialDate, required DateTime firstDate, required DateTime lastDate, DateTime? currentDate, DatePickerEntryMode initialEntryMode = DatePickerEntryMode.calendar, SelectableDayPredicate? selectableDayPredicate, String? helpText, String? cancelText, String? confirmText, Locale? locale, bool useRootNavigator = true, RouteSettings? routeSettings, TextDirection? textDirection, TransitionBuilder? builder, DatePickerMode initialDatePickerMode = DatePickerMode.day, String? errorFormatText, String? errorInvalidText, String? fieldHintText, String? fieldLabelText}) → Future<DateTime?>

showDateRangePicker({DateTimeRange? initialDateRange, required DateTime firstDate, required DateTime lastDate, DateTime? currentDate, DatePickerEntryMode initialEntryMode = DatePickerEntryMode.calendar, String? helpText, String? cancelText, String? confirmText, String? saveText, String? errorFormatText, String? errorInvalidText, String? errorInvalidRangeText, String? fieldStartHintText, String? fieldEndHintText, String? fieldStartLabelText, String? fieldEndLabelText, Locale? locale, bool useRootNavigator = true, RouteSettings? routeSettings, TextDirection? textDirection, TransitionBuilder? builder}) → Future<DateTimeRange?>

showDialog({required WidgetBuilder builder, bool barrierDismissible = true, Color? barrierColor = Colors.black54, String? barrierLabel, bool useSafeArea = true, RouteSettings? routeSettings}) → Future

showGeneralDialog({required RoutePageBuilder pageBuilder, bool barrierDismissible = false, String? barrierLabel, Color barrierColor = const Color(0x80000000), Duration transitionDuration = const Duration(milliseconds: 200), RouteTransitionsBuilder? transitionBuilder, bool useRootNavigator = true, RouteSettings? routeSettings}) → Future

showLicensePage({String? applicationName, String? applicationVersion, Widget? applicationIcon, String? applicationLegalese, bool useRootNavigator = false}) → void

showMenu<T>({required RelativeRect position, required List<PopupMenuEntry<T>> items, T? initialValue, double? elevation, String? semanticLabel, ShapeBorder? shape, Color? color, bool useRootNavigator = false}) → Future

showModalBottomSheet({required WidgetBuilder builder, Color? backgroundColor, double? elevation, ShapeBorder? shape, Clip? clipBehavior, Color? barrierColor = Colors.black54, bool isScrollControlled = false, bool useRootNavigator = false, bool isDismissible = true, bool enableDrag = true, RouteSettings? routeSettings, AnimationController? transitionAnimationController}) → Future

showSearch<T>({required SearchDelegate<T> delegate, String? query = '', bool useRootNavigator = false}) → Future

showTimePicker({required TimeOfDay initialTime, TransitionBuilder? builder, bool useRootNavigator = true, TimePickerEntryMode initialEntryMode = TimePickerEntryMode.dial, String? cancelText, String? confirmText, String? helpText, RouteSettings? routeSettings}) → Future<TimeOfDay?>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited