GetInterface class abstract

GetInterface allows any auxiliary package to be merged into the "Get" class through extensions

Available extensions

• ExtensionBottomSheet
• ExtensionDialog
• ExtensionSnackbar
• GetNavigation
• GetResetExt
• Inst
• LocalesIntl
• LoopEventsExt
• NavTwoExt
• OverlayExt

Constructors

GetInterface()

Properties

arguments → dynamic

Available on GetInterface, provided by the GetNavigation extension

give current arguments

no setter

bottomBarHeight → double

Available on GetInterface, provided by the GetNavigation extension

The distance from the bottom edge to the first unpadded pixel, in physical pixels.

no setter

context → BuildContext?

Available on GetInterface, provided by the GetNavigation extension

give access to currentContext

no setter

currentRoute → String

Available on GetInterface, provided by the GetNavigation extension

give name from current route

no setter

customTransition ↔ CustomTransition?

Available on GetInterface, provided by the GetNavigation extension

getter/setter pair

defaultDialogTransitionCurve → Curve

Available on GetInterface, provided by the GetNavigation extension

no setter

defaultDialogTransitionDuration → Duration

Available on GetInterface, provided by the GetNavigation extension

no setter

defaultOpaqueRoute → bool

Available on GetInterface, provided by the GetNavigation extension

no setter

defaultPopGesture → bool

Available on GetInterface, provided by the GetNavigation extension

no setter

defaultTransition → Transition?

Available on GetInterface, provided by the GetNavigation extension

no setter

defaultTransitionCurve → Curve

Available on GetInterface, provided by the GetNavigation extension

no setter

defaultTransitionDuration → Duration

Available on GetInterface, provided by the GetNavigation extension

no setter

deviceLocale → Locale?

Available on GetInterface, provided by the GetNavigation extension

no setter

engine → WidgetsBinding

Available on GetInterface, provided by the GetNavigation extension

The current WidgetsBinding

no setter

fallbackLocale ↔ Locale?

Available on GetInterface, provided by the LocalesIntl extension

getter/setter pair

focusScope → FocusNode?

Available on GetInterface, provided by the GetNavigation extension

give access to FocusScope.of(context)

no setter

hashCode → int

The hash code for this object.

no setter, inherited

height → double

Available on GetInterface, provided by the GetNavigation extension

The vertical extent of this size

no setter

iconColor → Color?

Available on GetInterface, provided by the GetNavigation extension

give access to Theme.of(context).iconTheme.color

no setter

isBottomSheetOpen → bool?

Available on GetInterface, provided by the GetNavigation extension

check if bottomsheet is open

no setter

isDarkMode → bool

Available on GetInterface, provided by the GetNavigation extension

Check if dark mode theme is enable

no setter

isDialogOpen → bool?

Available on GetInterface, provided by the GetNavigation extension

check if dialog is open

no setter

isLogEnable ↔ bool

getter/setter pair

isOpaqueRouteDefault → bool

Available on GetInterface, provided by the GetNavigation extension

check if default opaque route is enable

no setter

isOverlaysClosed → bool

Available on GetInterface, provided by the GetNavigation extension

Returns true if there is no Snackbar, Dialog or BottomSheet open

no setter

isOverlaysOpen → bool

Available on GetInterface, provided by the GetNavigation extension

Returns true if a Snackbar, Dialog or BottomSheet is currently OPEN

no setter

isPlatformDarkMode → bool

Available on GetInterface, provided by the GetNavigation extension

Check if dark mode theme is enable on platform on android Q+

no setter

isPopGestureEnable → bool

Available on GetInterface, provided by the GetNavigation extension

check if popGesture is enable

no setter

isSnackbarOpen → bool

Available on GetInterface, provided by the GetNavigation extension

check if snackbar is open

no setter

key → GlobalKey<NavigatorState>

Available on GetInterface, provided by the GetNavigation extension

no setter

keys → Map<dynamic, GlobalKey<NavigatorState>>

Available on GetInterface, provided by the GetNavigation extension

no setter

locale ↔ Locale?

Available on GetInterface, provided by the LocalesIntl extension

getter/setter pair

log ↔ LogWriterCallback

getter/setter pair

mediaQuery → MediaQueryData

Available on GetInterface, provided by the GetNavigation extension

give access to Mediaquery.of(context)

no setter

overlayContext → BuildContext?

Available on GetInterface, provided by the GetNavigation extension

give access to current Overlay Context

no setter

parameters ↔ Map<String, String?>

Available on GetInterface, provided by the GetNavigation extension

getter/setter pair

pixelRatio → double

Available on GetInterface, provided by the GetNavigation extension

The number of device pixels for each logical pixel.

no setter

previousRoute → String

Available on GetInterface, provided by the GetNavigation extension

give name from previous route

no setter

rawRoute → Route?

Available on GetInterface, provided by the GetNavigation extension

check a raw current route

no setter

rootController → GetMaterialController

Available on GetInterface, provided by the GetNavigation extension

no setter

rootDelegate → GetDelegate

Available on GetInterface, provided by the NavTwoExt extension

no setter

routeInformationParser ↔ RouteInformationParser?

getter/setter pair

routerDelegate ↔ RouterDelegate?

getter/setter pair

routeTree → ParseRouteTree

Available on GetInterface, provided by the NavTwoExt extension

no setter

routing → Routing

Available on GetInterface, provided by the GetNavigation extension

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

size → Size

Available on GetInterface, provided by the GetNavigation extension

no setter

smartManagement ↔ SmartManagement

getter/setter pair

statusBarHeight → double

Available on GetInterface, provided by the GetNavigation extension

The distance from the top edge to the first unpadded pixel, in physical pixels.

no setter

testMode ↔ bool

Available on GetInterface, provided by the GetNavigation extension

getter/setter pair

textScaleFactor → double

Available on GetInterface, provided by the GetNavigation extension

The system-reported text scale.

no setter

textTheme → TextTheme

Available on GetInterface, provided by the GetNavigation extension

give access to TextTheme.of(context)

no setter

theme → ThemeData

Available on GetInterface, provided by the GetNavigation extension

give access to Theme.of(context)

no setter

translations → Map<String, Map<String, String>>

Available on GetInterface, provided by the LocalesIntl extension

no setter

width → double

Available on GetInterface, provided by the GetNavigation extension

The horizontal extent of this size.

no setter

window → SingletonFlutterWindow

Available on GetInterface, provided by the GetNavigation extension

The window to which this binding is bound.

no setter

Methods

addKey(GlobalKey<NavigatorState> newKey) → GlobalKey<NavigatorState>?

Available on GetInterface, provided by the GetNavigation extension

addPage(GetPage getPage) → void

Available on GetInterface, provided by the NavTwoExt extension

addPages(List<GetPage> getPages) → void

Available on GetInterface, provided by the NavTwoExt extension

addTranslations(Map<String, Map<String, String>> tr) → void

Available on GetInterface, provided by the LocalesIntl extension

appendTranslations(Map<String, Map<String, String>> tr) → void

Available on GetInterface, provided by the LocalesIntl extension

appUpdate() → void

Available on GetInterface, provided by the GetNavigation extension

asap<T>(T computation(), {bool condition()?}) → FutureOr<T>

Available on GetInterface, provided by the LoopEventsExt extension

back<T>({T? result, bool closeOverlays = false, bool canPop = true, int? id}) → void

Available on GetInterface, provided by the GetNavigation extension

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?>

Available on GetInterface, provided by the ExtensionBottomSheet extension

changeTheme(ThemeData theme) → void

Available on GetInterface, provided by the GetNavigation extension

changeThemeMode(ThemeMode themeMode) → void

Available on GetInterface, provided by the GetNavigation extension

clearRouteTree() → void

Available on GetInterface, provided by the NavTwoExt extension

clearTranslations() → void

Available on GetInterface, provided by the LocalesIntl extension

close(int times, [int? id]) → void

Available on GetInterface, provided by the GetNavigation extension

Navigation.popUntil() (with predicate) shortcut .

closeAllSnackbars() → void

Available on GetInterface, provided by the GetNavigation extension

closeCurrentSnackbar() → Future<void>

Available on GetInterface, provided by the GetNavigation extension

config({bool? enableLog, LogWriterCallback? logWriterCallback, bool? defaultPopGesture, bool? defaultOpaqueRoute, Duration? defaultDurationTransition, bool? defaultGlobalState, Transition? defaultTransition}) → void

Available on GetInterface, provided by the GetNavigation extension

change default config of Get

create<S>(InstanceBuilderCallback<S> builder, {String? tag, bool permanent = true}) → void

Available on GetInterface, provided by the Inst extension

Creates a new Class Instance S from the builder callbackS. Every time find<S>() is used, it calls the builder method to generate a new Instance S. It also registers each instance.onClose() with the current Route GetConfig.currentRoute to keep the lifecycle active. Is important to know that the instances created are only stored per Route. So, if you call Get.delete<T>() the "instance factory" used in this method (Get.create<T>()) will be removed, but NOT the instances already created by it. Uses tag as the other methods.

createDelegate({GetPage? notFoundRoute, List<NavigatorObserver>? navigatorObservers, TransitionDelegate? transitionDelegate, PopMode backButtonPopMode = PopMode.History, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.ReorderRoutes}) → GetDelegate

Available on GetInterface, provided by the NavTwoExt extension

createInformationParser({String initialRoute = '/'}) → GetInformationParser

Available on GetInterface, provided by the NavTwoExt extension

defaultDialog<T>({String title = "Alert", EdgeInsetsGeometry? titlePadding, TextStyle? titleStyle, Widget? content, EdgeInsetsGeometry? contentPadding, 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, WillPopCallback? onWillPop, GlobalKey<NavigatorState>? navigatorKey}) → Future<T?>

Available on GetInterface, provided by the ExtensionDialog extension

Custom UI Dialog.

delegate<TDelegate extends RouterDelegate<TPage>, TPage>() → TDelegate?

Available on GetInterface, provided by the NavTwoExt extension

Casts the stored router delegate to a desired type

delete<S>({String? tag, bool force = false}) → Future<bool>

Available on GetInterface, provided by the Inst extension

Clears all registered instances (and/or tags). Even the persistent ones.

deleteAll({bool force = false}) → Future<void>

Available on GetInterface, provided by the Inst extension

Deletes all Instances, cleaning the memory and closes any open controllers (DisposableInterface).

dialog<T>(Widget widget, {bool barrierDismissible = true, Color? barrierColor, bool useSafeArea = true, GlobalKey<NavigatorState>? navigatorKey, Object? arguments, Duration? transitionDuration, Curve? transitionCurve, String? name, RouteSettings? routeSettings}) → Future<T?>

Available on GetInterface, provided by the ExtensionDialog extension

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.

find<S>({String? tag}) → S

Available on GetInterface, provided by the Inst extension

Finds a Instance of the required Class <S>(or tag) In the case of using Get.create(), it will generate an Instance each time you call Get.find().

forceAppUpdate() → Future<void>

Available on GetInterface, provided by the GetNavigation extension

As a rule, Flutter knows which widget to update, so this command is rarely needed. We can mention situations where you use const so that widgets are not updated with setState, but you want it to be forcefully updated when an event like language change happens. using context to make the widget dirty for performRebuild() is a viable solution. However, in situations where this is not possible, or at least, is not desired by the developer, the only solution for updating widgets that Flutter does not want to update is to use reassemble to forcibly rebuild all widgets. Attention: calling this function will reconstruct the application from the sketch, use this with caution. Your entire application will be rebuilt, and touch events will not work until the end of rendering.

generalDialog<T>({required RoutePageBuilder pageBuilder, bool barrierDismissible = false, String? barrierLabel, Color barrierColor = const Color(0x80000000), Duration transitionDuration = const Duration(milliseconds: 200), RouteTransitionsBuilder? transitionBuilder, GlobalKey<NavigatorState>? navigatorKey, RouteSettings? routeSettings}) → Future<T?>

Available on GetInterface, provided by the ExtensionDialog extension

Api from showGeneralDialog with no context

global(int? k) → GlobalKey<NavigatorState>

Available on GetInterface, provided by the GetNavigation extension

isPrepared<S>({String? tag}) → bool

Available on GetInterface, provided by the Inst extension

Checks if an Instance<S> (or tag) returned from a factory builder Get.lazyPut(), is registered in memory.

isRegistered<S>({String? tag}) → bool

Available on GetInterface, provided by the Inst extension

Checks if a Class Instance<S> (or tag) is registered in memory.

lazyPut<S>(InstanceBuilderCallback<S> builder, {String? tag, bool fenix = false}) → void

Available on GetInterface, provided by the Inst extension

Creates a new Instance lazily from the <S>builder() callback.

lazyReplace<P>(InstanceBuilderCallback<P> builder, {String? tag, bool? fenix}) → void

Available on GetInterface, provided by the Inst extension

Replaces a parent instance with a new Instance

nestedKey(dynamic key) → GlobalKey<NavigatorState>?

Available on GetInterface, provided by the GetNavigation extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

off<T>(dynamic page, {bool opaque = false, Transition? transition, Curve? curve, bool? popGesture, int? id, String? routeName, dynamic arguments, Bindings? binding, bool fullscreenDialog = false, bool preventDuplicates = true, Duration? duration, double gestureWidth(BuildContext context)?}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.pushReplacement() shortcut .

offAll<T>(dynamic page, {RoutePredicate? predicate, bool opaque = false, bool? popGesture, int? id, String? routeName, dynamic arguments, Bindings? binding, bool fullscreenDialog = false, Transition? transition, Curve? curve, Duration? duration, double gestureWidth(BuildContext context)?}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Push a page and pop several pages in the stack until predicate returns true. predicate is optional

offAllNamed<T>(String newRouteName, {RoutePredicate? predicate, dynamic arguments, int? id, Map<String, String>? parameters}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.pushNamedAndRemoveUntil() shortcut.

offAndToNamed<T>(String page, {dynamic arguments, int? id, dynamic result, Map<String, String>? parameters}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.popAndPushNamed() shortcut.

offNamed<T>(String page, {dynamic arguments, int? id, bool preventDuplicates = true, Map<String, String>? parameters}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.pushReplacementNamed() shortcut.

offNamedUntil<T>(String page, RoutePredicate predicate, {int? id, dynamic arguments, Map<String, String>? parameters}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.pushNamedAndRemoveUntil() shortcut.

offUntil<T>(Route<T> page, RoutePredicate predicate, {int? id}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.pushAndRemoveUntil() shortcut.

put<S>(S dependency, {String? tag, bool permanent = false, InstanceBuilderCallback<S>? builder}) → S

Available on GetInterface, provided by the Inst extension

Injects an Instance<S> in memory.

putAsync<S>(AsyncInstanceBuilderCallback<S> builder, {String? tag, bool permanent = false}) → Future<S>

Available on GetInterface, provided by the Inst extension

async version of Get.put(). Awaits for the resolution of the Future from builder()parameter and stores the Instance returned.

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, Widget? mainButton, OnTap? onTap, Duration? duration = const Duration(seconds: 3), bool isDismissible = true, DismissDirection? dismissDirection, 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}) → SnackbarController

Available on GetInterface, provided by the ExtensionSnackbar extension

reload<S>({String? tag, String? key, bool force = false}) → void

Available on GetInterface, provided by the Inst extension

reloadAll({bool force = false}) → void

Available on GetInterface, provided by the Inst extension

removeRoute(Route route, {int? id}) → void

Available on GetInterface, provided by the GetNavigation extension

Navigation.removeRoute() shortcut.

replace<P>(P child, {String? tag}) → void

Available on GetInterface, provided by the Inst extension

Replace a parent instance of a class in dependency management with a child instance

reset({bool clearFactory = true, bool clearRouteBindings = true}) → void

Available on GetInterface, provided by the GetResetExt extension

resetRootNavigator() → void

Available on GetInterface, provided by the GetNavigation extension

showOverlay<T>({required Future<T> asyncFunction(), Color opacityColor = Colors.black, Widget? loadingWidget, double opacity = .5}) → Future<T>

Available on GetInterface, provided by the OverlayExt extension

showSnackbar(GetSnackBar snackbar) → SnackbarController

Available on GetInterface, provided by the ExtensionSnackbar extension

snackbar(String title, String message, {Color? colorText, Duration? duration = const Duration(seconds: 3), 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, TextButton? mainButton, OnTap? onTap, bool? isDismissible, bool? showProgressIndicator, DismissDirection? 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}) → SnackbarController

Available on GetInterface, provided by the ExtensionSnackbar extension

to<T>(dynamic page, {bool? opaque, Transition? transition, Curve? curve, Duration? duration, int? id, String? routeName, bool fullscreenDialog = false, dynamic arguments, Bindings? binding, bool preventDuplicates = true, bool? popGesture, double gestureWidth(BuildContext context)?}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.push() shortcut.

toEnd<T>(FutureOr<T> computation()) → Future<T>

Available on GetInterface, provided by the LoopEventsExt extension

toNamed<T>(String page, {dynamic arguments, int? id, bool preventDuplicates = true, Map<String, String>? parameters}) → Future<T?>?

Available on GetInterface, provided by the GetNavigation extension

Navigation.pushNamed() shortcut.

toString() → String

A string representation of this object.

inherited

until(RoutePredicate predicate, {int? id}) → void

Available on GetInterface, provided by the GetNavigation extension

Navigation.popUntil() shortcut.

updateLocale(Locale l) → Future<void>

Available on GetInterface, provided by the GetNavigation extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited