GetNavigation extension

on

Properties

arguments → dynamic
give current arguments
read-only
context BuildContext
give access to currentContext
read-only
currentRoute String
give name from current route
read-only
customTransition CustomTransition
read / write
defaultDialogTransitionCurve Curve
read-only
defaultDialogTransitionDuration Duration
read-only
defaultOpaqueRoute bool
read-only
defaultPopGesture bool
read-only
defaultTransition Transition
read-only
defaultTransitionCurve Curve
read-only
defaultTransitionDuration Duration
read-only
focusScope FocusNode
give access to FocusScope.of(context)
read-only
height double
give access to Immutable MediaQuery.of(context).size.height
read-only
iconColor Color
give access to Theme.of(context).iconTheme.color
read-only
isBottomSheetOpen bool
check if bottomsheet is open
read-only
isDarkMode bool
Check if dark mode theme is enable
read-only
isDialogOpen bool
check if dialog is open
read-only
isOpaqueRouteDefault bool
check if default opaque route is enable
read-only
isOverlaysClosed bool
Returns true if there is no Snackbar, Dialog or BottomSheet open
read-only
isOverlaysOpen bool
Returns true if a Snackbar, Dialog or BottomSheet is currently OPEN
read-only
isPlatformDarkMode bool
Check if dark mode theme is enable on platform on android Q+
read-only
isPopGestureEnable bool
check if popGesture is enable
read-only
isSnackbarOpen bool
check if snackbar is open
read-only
key GlobalKey<NavigatorState>
read-only
keys Map<int, GlobalKey<NavigatorState>>
read-only
mediaQuery MediaQueryData
give access to Mediaquery.of(context)
read-only
overlayContext BuildContext
give access to current Overlay Context
read-only
parameters Map<String, String>
read / write
previousRoute String
give name from previous route
read-only
rawRoute Route
check a raw current route
read-only
rootController → GetMaterialController
read-only
routeSettings RouteSettings
@Deprecated(''' Since version 2.8 it is possible to access the properties [Get.arguments] and [Get.currentRoute] directly. [routeSettings] is useless and should not be used.'''), read-only
routeTree ↔ ParseRouteTree
read / write
routing Routing
read-only
testMode bool
read / write
textTheme TextTheme
give access to TextTheme.of(context)
read-only
theme ThemeData
give access to Theme.of(context)
read-only
width double
give access to Immutable MediaQuery.of(context).size.width
read-only

Methods

addKey(GlobalKey<NavigatorState> newKey) GlobalKey<NavigatorState>
addPage(GetPage getPage) → void
addPages(List<GetPage> getPages) → void
appUpdate() → void
back({dynamic result, bool closeOverlays = false, bool canPop = true, int id}) → void
Navigation.popUntil() shortcut.

[...]
bottomSheet<T>(Widget bottomsheet, {Color backgroundColor, double elevation, bool persistent = true, ShapeBorder shape, Clip clipBehavior, Color barrierColor, bool ignoreSafeArea, bool isScrollControlled = false, bool useRootNavigator = false, bool isDismissible = true, bool enableDrag = true, RouteSettings settings, Duration enterBottomSheetDuration, Duration exitBottomSheetDuration}) Future<T>
changeTheme(ThemeData theme) → void
changeThemeMode(ThemeMode themeMode) → void
close(int times, [int id]) → void
Navigation.popUntil() (with predicate) shortcut .

[...]
config({bool enableLog, LogWriterCallback logWriterCallback, bool defaultPopGesture, bool defaultOpaqueRoute, Duration defaultDurationTransition, bool defaultGlobalState, Transition defaultTransition}) → void
change default config of Get
defaultDialog<T>({String title = "Alert", TextStyle titleStyle, Widget content, VoidCallback onConfirm, VoidCallback onCancel, VoidCallback onCustom, Color cancelTextColor, Color confirmTextColor, String textConfirm, String textCancel, String textCustom, Widget confirm, Widget cancel, Widget custom, Color backgroundColor, bool barrierDismissible = true, Color buttonColor, String middleText = "Dialog made in 3 lines of code", TextStyle middleTextStyle, double radius = 20.0, List<Widget> actions}) Future<T>
Custom UI Dialog.
dialog<T>(Widget widget, {bool barrierDismissible = true, Color barrierColor, bool useSafeArea = true, bool useRootNavigator = true, RouteSettings routeSettings, Duration transitionDuration, Curve transitionCurve}) Future<T>
Show a dialog. You can pass a transitionDuration and/or transitionCurve, overriding the defaults when the dialog shows up and closes. When the dialog closes, uses those animations in reverse.
forceAppUpdate() → void
generalDialog<T>({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<T>
Api from showGeneralDialog with no context
global(int k) GlobalKey<NavigatorState>
nestedKey(int key) GlobalKey<NavigatorState>
off<T>(Widget page, {bool opaque = false, Transition transition, Curve curve, bool popGesture, int id, dynamic arguments, Bindings binding, bool fullscreenDialog = false, bool preventDuplicates = true, Duration duration}) Future<T>
Navigation.pushReplacement() shortcut .

[...]
offAll<T>(Widget page, {RoutePredicate predicate, bool opaque = false, bool popGesture, int id, dynamic arguments, Bindings binding, bool fullscreenDialog = false, Transition transition, Curve curve, Duration duration}) Future<T>
Navigation.pushAndRemoveUntil() shortcut .

[...]
offAllNamed<T>(String newRouteName, {RoutePredicate predicate, dynamic arguments, int id}) Future<T>
Navigation.pushNamedAndRemoveUntil() shortcut.

[...]
offAndToNamed<T>(String page, {dynamic arguments, int id, dynamic result}) Future<T>
Navigation.popAndPushNamed() shortcut.

[...]
offNamed<T>(String page, {dynamic arguments, int id, bool preventDuplicates = true}) Future<T>
Navigation.pushReplacementNamed() shortcut.

[...]
offNamedUntil<T>(String page, RoutePredicate predicate, {int id, dynamic arguments}) Future<T>
Navigation.pushNamedAndRemoveUntil() shortcut.

[...]
offUntil<T>(Route<T> page, RoutePredicate predicate, {int id}) Future<T>
Navigation.pushAndRemoveUntil() shortcut.

[...]
rawSnackbar({String title, String message, Widget titleText, Widget messageText, Widget icon, bool instantInit = true, bool shouldIconPulse = true, double maxWidth, EdgeInsets margin = const EdgeInsets.all(0.0), EdgeInsets padding = const EdgeInsets.all(16), double borderRadius = 0.0, Color borderColor, double borderWidth = 1.0, Color backgroundColor = const Color(0xFF303030), Color leftBarIndicatorColor, List<BoxShadow> boxShadows, Gradient backgroundGradient, FlatButton mainButton, OnTap onTap, Duration duration = const Duration(seconds: 3), bool isDismissible = true, SnackDismissDirection dismissDirection = SnackDismissDirection.VERTICAL, bool showProgressIndicator = false, AnimationController progressIndicatorController, Color progressIndicatorBackgroundColor, Animation<Color> progressIndicatorValueColor, SnackPosition snackPosition = SnackPosition.BOTTOM, SnackStyle snackStyle = SnackStyle.FLOATING, Curve forwardAnimationCurve = Curves.easeOutCirc, Curve reverseAnimationCurve = Curves.easeOutCirc, Duration animationDuration = const Duration(seconds: 1), SnackbarStatusCallback snackbarStatus, double barBlur = 0.0, double overlayBlur = 0.0, Color overlayColor, Form userInputForm}) → void
removeRoute(Route route, {int id}) → void
Navigation.removeRoute() shortcut.

[...]
showSnackbar<T>(GetBar<Object> snackbar) Future<T>
snackbar(String title, String message, {Color colorText, Duration duration, bool instantInit = true, SnackPosition snackPosition, Widget titleText, Widget messageText, Widget icon, bool shouldIconPulse, double maxWidth, EdgeInsets margin, EdgeInsets padding, double borderRadius, Color borderColor, double borderWidth, Color backgroundColor, Color leftBarIndicatorColor, List<BoxShadow> boxShadows, Gradient backgroundGradient, FlatButton mainButton, OnTap onTap, bool isDismissible, bool showProgressIndicator, SnackDismissDirection dismissDirection, AnimationController progressIndicatorController, Color progressIndicatorBackgroundColor, Animation<Color> progressIndicatorValueColor, SnackStyle snackStyle, Curve forwardAnimationCurve, Curve reverseAnimationCurve, Duration animationDuration, double barBlur, double overlayBlur, SnackbarStatusCallback snackbarStatus, Color overlayColor, Form userInputForm}) → void
to<T>(Widget page, {bool opaque, Transition transition, Curve curve, Duration duration, int id, bool fullscreenDialog = false, dynamic arguments, Bindings binding, bool preventDuplicates = true, bool popGesture}) Future<T>
Navigation.push() shortcut.

[...]
toNamed<T>(String page, {dynamic arguments, int id, bool preventDuplicates = true}) Future<T>
Navigation.pushNamed() shortcut.

[...]
until(RoutePredicate predicate, {int id}) → void
Navigation.popUntil() shortcut.

[...]
updateLocale(Locale l) → void

Static Properties

getxController ↔ GetMaterialController
read / write