routes library

Classes

AdvancedRouteSettings
AndroidModalOpener<T>
AuthModalArgs
CupertinoModalOpener<T>
DesktopModalOpener
DragHandle
HandleSheet
IdArgs<R>
KeyArgs<R>
ModalOpener
Describes how to open modal windows on the various platforms. A new modal opener can be registered by using Modals.register
Modals
NestedNavigatorContainer
NonOpaqueCupertinoPageRoute<T>
Creates a platform-appropriate page route.
RouteExtensions
ScrollerArgs
SunnyRouterFactory
SunnyRouting
TabRouteArgs

Extensions

AppRouteExtension on AppRoute<dynamic, RouteParams>
AppRouteGoNavigationExtension on AppRoute<R, P>?
AppRouteKeyNavExtension on AppRoute<R, KeyArgs<T>>
AppRouteMatchExtensions on AppRouteMatch<dynamic, RouteParams>
AppRouteMatchGoExtension on AppRouteMatch<dynamic, RouteParams>
AppRouteNavigationExtension on AppRoute<R, P>
AppRouteTypedExtension on AppRoute<R, P>
BuildContextDeviceScreenTypeExt on BuildContext
BuildContextNestedNavigator on BuildContext
FRouterExtensions on FRouter
MModelIdArgsExt on X
MSchemaRefExt on MSchemaRef
MSchemaRefKeyExtension on MSchemaRef
RouteCast on Route
TabPageExt on FRouter
TypeToRouteExt on dynamic
WidgetDragHandleExt on Widget

Properties

nestedGlobalKey → GlobalKey<NavigatorState>
final

Functions

bottomSheetModal<T>(BuildContext context, WidgetBuilder scrollBuilder, {bool displayDragHandle = true}) → Future<T?>
cupertinoMenuOpener<T>({bool useScaffold = true}) → OpenMenu<T>
memoizeScrollBuild(WidgetBuilder builder) → WidgetBuilder
memoizeScrollToNon(WidgetBuilder builder) → WidgetBuilder
memoizeWidgetBuilder(WidgetBuilder builder) → WidgetBuilder
nestedModal<T>(BuildContext context, WidgetBuilder scrollBuilder, {bool displayDragHandle = true, required PathRouteSettings? settings}) → Future<T?>
openAndroidMenu<T>(BuildContext context, {required WidgetBuilder builder, bool displayDragHandle = true, bool dismissible = true, bool draggable = true, PathRouteSettings? settings, double? width, double? height, bool expand = false, bool useRootNavigator = true, bool nestModals = false, Constraints? constraints}) → Future<T?>
openDesktopMenu<T>(BuildContext context, {required WidgetBuilder builder, bool displayDragHandle = true, bool dismissible = true, bool draggable = true, PathRouteSettings? settings, double? width, double? height, bool useRootNavigator = true, bool expand = false, bool nestModals = false, Constraints? constraints}) → Future<T?>
PlatformPageRoute<T>({WidgetBuilder? builder, RouteSettings? settings, bool maintainState = true, bool fullscreenDialog = false, bool nonOpaque = true, bool forceMaterial = false, bool inPageRoute = false}) → PageRoute<T>
Creates a platform-appropriate page route.
showPlatformMenu<T>(BuildContext context, {required WidgetBuilder builder, bool useScaffold = true, bool displayDragHandle = true, bool dismissible = true, bool draggable = true, Constraints? constraints, PathRouteSettings? settings, double? width, double? height, bool expand = false, bool useRootNavigator = true, bool nestModals = false}) → Future<T?>
simple<R, P>(Widget builder()) → WidgetHandler<R, P>
widgetWithDragHandle({Widget? child}) → Widget

Typedefs

ModalArgsBuilder<P extends RouteParams> = P Function(ScrollController? controller)
Passes the ScrollController to the route args
ModalOpenerOverride = ModalOpener? Function(BuildContext context, {bool useScaffold})
OnGenerateRoute<T> = Route<T> Function(RouteSettings settings)
OpenMenu<T> = Future<T?> Function(BuildContext context, {required WidgetBuilder builder, Constraints? constraints, bool dismissible, bool displayDragHandle, bool draggable, bool expand, double? height, bool nestModals, PathRouteSettings? settings, bool useRootNavigator, double? width})
OpenModal<T> = Future<T?> Function(BuildContext context, {required WidgetBuilder builder, bool dismissible, bool displayDragHandle, bool draggable, bool expand, double? height, bool nestModals, PathRouteSettings? settings, bool useRootNavigator, double? width})