getxify library

Classes

BackButtonCallback
Bind<T>
BindElement<T>
The BindElement is responsible for injecting dependencies into the widget tree so that they can be observed
Binder<T>
Binding
An interface to define dependency injection rules for routes or specific flows in GetXify v5.0.0.
Binds
BlurAnimation
Animation that applies a blur filter to the child from begin to end sigma.
BounceAnimation
Animation that applies a bouncing scale effect to a widget.
CircularRevealClipper
A custom clipper that creates a circular reveal animation effect.
CircularRevealTransition
ColorAnimation
Animation that transitions the color filter of a widget between two colors.
CustomStatus<T>
CustomTransition
Abstract class for defining custom page transitions.
DeepCollectionEquality
DefaultEquality<E>
Dependencies
EmptyStatus<T>
Engine
Helper class to interact with the Flutter framework's bindings.
ErrorStatus<T>
FadeInAnimation
Animation that fades in a widget by transitioning its opacity from 0.0 to 1.0.
FadeInTransition
FadeOutAnimation
Animation that fades out a widget by transitioning its opacity from 1.0 to 0.0.
FlipAnimation
Animation that flips a widget around its Y-axis from begin to end phase.
FullLifeCycleController
A controller that can observe the full app lifecycle.
GetAnimatedBuilder<T>
A widget that animates a tween value over a duration after a specified delay.
GetAnimatedBuilderState<T>
The state for GetAnimatedBuilder managing the animation lifecycle.
GetBackGestureController<T>
GetBackGestureDetector<T>
GetBackGestureDetectorState<T>
GetBuilder<T extends GetxController>
GetCupertinoApp
A fully customized CupertinoApp designed to be the entry point for GetXify applications.
GetDelegate
GetDependencyScope
A widget that manages the lifecycle of dependencies created within its scope.
GetInformationParser
GetInterface
The base class/interface that allows other packages (like navigation, state management, etc.) to merge their capabilities into the global Get instance through Dart extensions.
GetListenable<T>
GetMaterialApp
A fully customized MaterialApp designed to be the entry point for GetXify applications.
GetMiddleware
The Page Middlewares. The Functions will be called in this order (( redirect -> onPageCalled -> onBindingsStart -> onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute<T>
A customized PopupRoute used to display a modal bottom sheet.
GetNavigator
A Navigator preconfigured for GetX's Router (Navigator 2.0) flow.
GetNotifier<T>
GetObserver
GetPage<T>
GetPageRoute<T>
GetPlatform
GetQueue
GetResponsiveView<T>
A responsive view that extends GetView with responsive capabilities.
GetRouteInformationProvider
A RouteInformationProvider that keeps the platform (browser) history in sync with the page stack managed by a GetDelegate.
GetRouterOutlet
GetSnackBar
GetSnackBarState
GetStatus<T>
Sealed class representing different states of a notifier.
GetTickerProvider
Common interface of GetSingleTickerProviderStateMixin and GetTickerProviderStateMixin: a TickerProvider whose tickers follow the TickerMode of the widget subtree that forwards its dependency changes to didChangeDependencies.
GetTransitionDelegate<T>
A TransitionDelegate that resolves page-list changes like the framework's DefaultTransitionDelegate, except while isPopNavigation reports that the change being applied was caused by a back navigation.
GetView<T>
GetView is a lightweight StatelessWidget providing easy access to a controller registered in dependency injection without calling Get.find<Controller>() manually.
GetxController
A base controller class that provides state management functionality.
GetxService
Unlike GetxController, which serves to control events on each of its pages, GetxService is not automatically disposed (nor can be removed with Get.delete()). It is ideal for situations where, once started, that service will remain in memory, such as Auth control for example. Only way to remove it is Get.reset().
IdentityEquality<E>
Equality of objects that compares only the identity of the objects.
IEquality<E>
A generic equality relation on objects.
IndexedRouteBuilder<T>
InheritedNavigator
InstanceInfo
Holds metadata about the registration and lifecycle state of an instance.
IterableEquality<E>
Equality on iterables.
LeftToRightFadeTransition
ListEquality<E>
Equality on lists.
LoadingStatus<T>
MapEquality<K, V>
Equality on maps.
MiddlewareRunner
Module
ModuleState
NoTransition
Observer
An experimental widget that observes reactive changes.
Obx
The simplest reactive widget in GetX.
ObxElement
Element for Obx widgets that tracks reactive dependencies.
ObxStatelessWidget
A StatelessWidget that can listen to reactive changes.
ObxValue<T extends RxInterface>
Similar to Obx, but manages a local state. Pass the initial data in constructor. Useful for simple local states, like toggles, visibility, themes, button states, etc. Sample: ObxValue((data) => Switch( value: data.value, onChanged: (flag) => data.value = flag, ), false.obs, ),
ObxWidget
The ObxWidget is the base for all GetX reactive widgets
OpacityAnimation
Base class for opacity-based animations.
PageRedirect
PageSettings
ParseRouteTree
ResponsiveScreen
Provides information about the current screen.
ResponsiveScreenSettings
Settings for responsive screen breakpoints.
RightToLeftFadeTransition
RotateAnimation
Animation that rotates a widget from begin to end angle in radians.
RouteDecoder
RouteListenerState
RouterListener
RouterListenerInherited
RouterListenerState
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
Rx<T>
Foundation class used for custom Types outside the common native Dart types. For example, any custom "Model" class, like User().obs will use Rx as wrapper.
RxController
A base controller class for reactive state management using Rx variables.
RxInterface<T>
This class is the foundation for all reactive (Rx) classes that make Get so powerful.
RxList<E>
Create a list similar to List<T> but reactive.
RxMap<K, V>
Create a map similar to Map<K, V> but reactive.
Rxn<T>
RxSet<E>
Create a set similar to Set<T> but reactive.
ScaleAnimation
Animation that scales a widget from begin to end scale factor.
SetEquality<E>
Equality of sets.
SizeAnimation
Animation that transitions a widget's size/scale from begin to end.
SizeTransitions
SlideAnimation
Base slide animation class that shifts a widget position using OffsetBuilder.
SlideDownTransition
SlideInDownAnimation
Slide animation that enters the child widget from the top downward.
SlideInLeftAnimation
Slide animation that enters the child widget from the left of the screen.
SlideInRightAnimation
Slide animation that enters the child widget from the right of the screen.
SlideInUpAnimation
Slide animation that enters the child widget from the bottom upward.
SlideLeftTransition
SlideRightTransition
SlideTopTransition
SnackbarController
SnackBarQueue
SpinAnimation
Animation that spins a widget 360 degrees.
StateController<T>
A controller that manages state for asynchronous operations.
SuccessStatus<T>
SuperController<T>
A controller that combines full lifecycle management with state management.
Translations
The base abstract class used for providing localized translations to the app.
UnorderedIterableEquality<E>
Equality of the elements of two iterables without considering order.
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
The state for ValueBuilder.
WaveAnimation
Animation that moves a widget up and down in a wave motion on the Y-axis.
WobbleAnimation
Animation that wobbles a widget with a perspective rotation Z.
Worker
Workers
ZoomInTransition

Enums

PluralCase
The CLDR plural categories used to pick the correct plural form of a translation key for a given count.
PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that shouldn't be duplicates
RowStyle
ScreenType
Enum representing different screen types.
SnackbarStatus
Indicates Status of snackbar SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar has closed, SnackbarStatus.OPENING Starts with the opening animation and ends with the full snackbar display, SnackbarStatus.CLOSING Starts with the closing animation and ends with the full snackbar dispose
SnackHoverState
Indicates if the mouse entered or exited
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
Transition

Mixins

Equality
FullLifeCycleMixin
A mixin that provides full lifecycle callbacks for the controller.
GetLifeCycleMixin
Mixin that provides lifecycle methods for controllers.
GetPageRouteTransitionMixin<T>
GetResponsiveMixin
Mixin that provides responsive building capabilities.
GetRestorationMixin
A mixin that provides Flutter state restoration support to GetLifeCycleMixin controllers.
GetSingleTickerProviderStateMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
GetTickerProviderStateMixin
Used like TickerProviderMixin but only with Get Controllers. Simplifies multiple AnimationController creation inside GetxController.
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
IGetNavigation
RouterListenerMixin<T extends StatefulWidget>
RxObjectMixin<T>
global object that registers against GetX and Obx, and allows the reactivity of those Widgets and Rx values.
ScrollMixin
A mixin that provides scroll-based data fetching capabilities.
StatelessObserverComponent
Mixin that adds reactive tracking to StatelessElement.
StateMixin<T>
Mixin that adds state management with status tracking.

Extensions

AnimationExtension on Widget
Extension to easily chain animation builders onto any Widget.
BoolExtension on bool
ContextExt on BuildContext
ContextNavigationExt on BuildContext
DoubleExtension on double
ExtensionBottomSheet on GetInterface
ExtensionDialog on GetInterface
ExtensionSnackbar on GetInterface
GetInstanceExt on GetInterface
Main extension on GetInterface providing dependency injection features.
GetNavigationExt on GetInterface
GetResetExt on GetInterface
Extension on GetInterface providing utilities to reset application state.
IntExtension on int
IterableExtensions on Iterable<T>
Useful extensions for Iterable.
ListExtension on List<E>
LocalesIntl on GetInterface
LoopEventsExt on GetInterface
MapExtension on Map<K, V>
OverlayExt on GetInterface
PageArgExt on BuildContext
PagesListExt on List<GetPage>
ReadExt on BuildContext
ResetInstance on GetInterface
Extension on GetInterface to reset and clear registered instances.
RxBoolExt on Rx<bool>
RxDoubleExt on Rx<double>
Extension on Rx<double> providing basic double operators with chaining support.
RxIntExt on Rx<int>
Extension on Rx<int> providing basic integer operators with chaining support.
RxnBoolExt on Rx<bool?>
RxnDoubleExt on Rx<double?>
Extension on Rx<double?> providing basic double operators with chaining support.
RxnIntExt on Rx<int?>
Extension on Rx<int?> providing basic integer operators with chaining support.
RxnNumExt on Rx<T?>
Extension on Rx<num?> providing basic operators.
RxnStringExt on Rx<String?>
Extension on Rx<String?> providing standard operators.
RxNumExt on Rx<T>
Extension on Rx<num> providing basic operators.
RxStringExt on Rx<String>
Extension on Rx<String> providing standard operators.
RxT on T
RxTNew on Object
This method replaces the old .obs extension to avoid conflicts with Dart 3 features. T will be inferred by contextual type inference.
SetExtension on Set<E>
StateExt on StateMixin<T>
StatusDataExt on GetStatus<T>
StringExtension on String
Trans on String
WatchExt on BuildContext

Constants

rtlLanguages → const List<String>
A predefined list of languages that are natively read Right-to-Left (RTL).

Properties

Get → _GetImpl
The global entrypoint for accessing GetX APIs.
final
It replaces the Flutter Navigator, but needs no context. You can to use navigator.push(YourRoute()) rather Navigator.push(context, YourRoute());
no setter

Functions

debounce<T>(GetListenable<T> listener, WorkerCallback<T> callback, {Duration? time, Object? condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
debounce is similar to interval, but sends the last value. Useful for Anti DDos, every time the user stops typing for 1 second, for instance. When listener emits the last "value", when time hits, it calls callback with the last "value" emitted.
defaultLogWriterCallback(String value, {bool isError = false}) → void
The default log writer callback used by GetX.
evaluateCondition(Object? condition) → bool
Evaluates a condition for extension methods with consistent false-by-default behavior. Used by list, map, and set extensions for conditional operations. Accepts null, bool, or bool Function() and returns a consistent boolean result.
ever<T>(GetListenable<T> listener, WorkerCallback<T> callback, {Object? condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Called every time listener changes. As long as the condition returns true.
everAll(List<RxInterface> listeners, WorkerCallback callback, {Object? condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Similar to ever, but takes a list of listeners, the condition for the callback is common to all listeners, and the callback is executed to each one of them. The Worker is common to all, so worker.dispose() will cancel all streams.
interval<T>(GetListenable<T> listener, WorkerCallback<T> callback, {Duration time = const Duration(seconds: 1), Object? condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Ignore all changes in listener during time (1 sec by default) or until condition is met (can be a bool expression or a bool Function()), It brings the 1st "value" since the period of time, so if you click a counter button 3 times in 1 sec, it will show you "1" (after 1 sec of the first press) click counter 3 times in 1 sec, it will show you "4" (after 1 sec) click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
once<T>(GetListenable<T> listener, WorkerCallback<T> callback, {Object? condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
once() will execute only 1 time when condition is met and cancel the subscription to the listener stream right after that. condition defines when callback is called, and can be a bool or a bool Function().
removeLastHistory(String? url) → void
setUrlStrategy() → void

Typedefs

AsyncInstanceBuilderCallback<S> = Future<S> Function()
Callback type for asynchronously building instances of type S.
BindingBuilderCallback = void Function()
A callback used to lazily initialize or register bindings.
FuturizeCallback<T> = Future<T> Function(VoidCallback fn)
GetControllerBuilder<T extends GetLifeCycleMixin> = Widget Function(T controller)
GetPageBuilder = Widget Function()
GetRouteAwarePageBuilder<T> = Widget Function([GetPageRoute<T>? route])
GetState<T> = GetStatus<T>
InitBuilder<T> = T Function()
InstanceBuilderCallback<S> = S Function()
Callback type for building singleton or lazy instances of type S.
InstanceCreateBuilderCallback<S> = S Function(BuildContext _)
Callback type for building instances of type S on demand using BuildContext.
LogWriterCallback = void Function(String text, {bool isError})
Signature for a custom log writer function callback.
NotifierBuilder<T> = Widget Function(T state)
OffsetBuilder = Offset Function(BuildContext, double)
Signature for a builder function that determines the slide Offset based on value.
OnHover = void Function(GetSnackBar snack, SnackHoverState snackHoverState)
OnTap = void Function(GetSnackBar snack)
PluralResolver = PluralCase Function(int count, Locale? locale)
Maps a count under locale to the PluralCase whose translation should be used. Installed through LocalesIntl.pluralResolver.
RxBool = Rx<bool>
RxDouble = Rx<double>
RxInt = Rx<int>
RxnBool = Rx<bool?>
RxnDouble = Rx<double?>
RxnInt = Rx<int?>
RxnNum = Rx<num?>
RxnString = Rx<String?>
RxNum = Rx<num>
RxString = Rx<String>
SnackbarStatusCallback = void Function(SnackbarStatus? status)
ValueBuilderBuilder<T> = Widget Function(T snapshot, ValueBuilderUpdateCallback<T> updater)
Builder function for ValueBuilder.
ValueBuilderUpdateCallback<T> = void Function(T snapshot)
Callback function to update the value in ValueBuilder.
ValueUpdater<T> = T Function()
Signature for a callback that returns a value of type T.
VoidCallback = void Function()
WidgetCallback = Widget Function()
WorkerCallback<T> = dynamic Function(T callback)

Exceptions / Errors

BindError<T>
InstanceNotFoundException
Exception thrown when a requested dependency has not been registered in the dependency manager.
RouteNotFoundException