state_manager library
Get State Manager is a light, modern and powerful state manager to Flutter
Classes
- DisposableInterface
-
FastList<
T> - FullLifeCycleController
-
GetBuilder<
T extends GetxController> -
GetBuilderState<
T extends GetxController> - GetInterface
- GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
-
GetNotifier<
T> -
GetResponsiveView<
T> -
Extend this widget to build responsive view.
this widget contains the
screen
property that have all information about the screen size and type. You have two options to build it. 1- withbuilder
method you return the widget to build. 2- with methodsdesktop
,tablet
,phone
,watch
. the specific method will be built when the screen type matches the method when the screen is ScreenType.Tablet thetablet
method will be exuded and so on. Note if you use this method please set the propertyalwaysUseBuilder
to false Withsettings
property you can set the width limit for the screen types. -
GetResponsiveWidget<
T extends GetLifeCycleBase?> -
GetStream<
T> - GetStream is the lightest and most performative way of working with events at Dart. You sintaxe is like StreamController, but it works with simple callbacks. In this way, every event calls only one function. There is no buffering, to very low memory consumption. event add will add a object to stream. addError will add a error to stream. listen is a very light StreamSubscription interface. Is possible take the last value with value property.
-
GetStreamTransformation<
T> -
GetView<
T> - GetView is a great way of quickly access your Controller without having to call Get.find
-
GetWidget<
S extends GetLifeCycleBase?> - GetWidget is a great way of quickly access your individual Controller without having to call Get.find
-
GetX<
T extends DisposableInterface> - GetxController
- 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().
-
GetXState<
T extends DisposableInterface> -
LightSubscription<
T> -
MiniStream<
T> -
MiniSubscription<
T> -
MixinBuilder<
T extends GetxController> -
Node<
T> - Obx
- The simplest reactive widget in GetX.
- ObxState
-
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
- ResponsiveScreen
- ResponsiveScreenSettings
-
Rx<
T> -
Foundation class used for custom
Types
outside the common native Dart types. For example, any custom "Model" class, like User().obs will useRx
as wrapper. - RxBool
- RxController
- RxDouble
- RxInt
-
RxInterface<
T> - This class is the foundation for all reactive (Rx) classes that makes Get so powerful. This interface is the contract that _RxImpl]
-
RxList<
E> -
Create a list similar to
List<T>
-
RxMap<
K, V> -
Rxn<
T> - RxnBool
- RxnDouble
- RxnInt
- RxnNum
-
RxNotifier<
T> - RxnString
-
Rx class for
String
Type. - RxNum
-
RxSet<
E> - RxStatus
- RxString
-
Rx class for
String
Type. - SimpleBuilder
- SimpleBuilderState
-
SuperController<
T> -
Value<
T> -
ValueBuilder<
T> - Manages a local state like ObxValue, but uses a callback instead of a Rx value.
-
ValueBuilderState<
T> - Worker
- Workers
Enums
- ScreenType
- SmartManagement
- GetX by default disposes unused controllers from memory, Through different behaviors. SmartManagement.full SmartManagement.full is the default one. Dispose classes that are not being used and were not set to be permanent. In the majority of the cases you will want to keep this config untouched. If you new to GetX then don't change this. SmartManagement.onlyBuilder only controllers started in init: or loaded into a Binding with Get.lazyPut() will be disposed. If you use Get.put() or Get.putAsync() or any other approach, SmartManagement will not have permissions to exclude this dependency. With the default behavior, even widgets instantiated with "Get.put" will be removed, unlike SmartManagement.onlyBuilders. SmartManagement.keepFactoryJust like SmartManagement.full, it will remove it's dependencies when it's not being used anymore. However, it will keep their factory, which means it will recreate the dependency if you need that instance again.
Mixins
- FullLifeCycleMixin
- GetResponsiveMixin
- GetSingleTickerProviderStateMixin
-
Used like
SingleTickerProviderMixin
but only with Get Controllers. Simplifies AnimationController creation inside GetxController. -
GetStateUpdaterMixin<
T extends StatefulWidget> -
Complies with
GetStateUpdater
- GetTickerProviderStateMixin
-
Used like
TickerProviderMixin
but only with Get Controllers. Simplifies multiple AnimationController creation inside GetxController. -
NotifyManager<
T> -
RxObjectMixin<
T> -
global object that registers against
GetX
andObx
, and allows the reactivity of thoseWidgets
and Rx values. - ScrollMixin
- SingleGetTickerProviderMixin
-
Used like
SingleTickerProviderMixin
but only with Get Controllers. Simplifies AnimationController creation inside GetxController. -
StateMixin<
T>
Extensions
- BoolExtension on bool
- DoubleExtension on double
- IntExtension on int
-
ListExtension
on List<
E> -
MapExtension
on Map<
K, V> - ReactiveT on T
-
RxBoolExt
on Rx<
bool> -
RxDoubleExt
on Rx<
double> -
RxIntExt
on Rx<
int> -
RxnBoolExt
on Rx<
bool?> -
RxnDoubleExt
on Rx<
double?> -
RxnIntExt
on Rx<
int?> -
RxnNumExt
on Rx<
T?> -
RxnStringExt
on Rx<
String?> -
RxNumExt
on Rx<
T> -
RxStringExt
on Rx<
String> - RxT on T
-
SetExtension
on Set<
E> -
StateExt
on StateMixin<
T> - StringExtension on String
Properties
- Get → _GetImpl
-
final
Functions
-
ambiguate<
T> (T? value) → T? -
debounce<
T> (RxInterface< T> listener, WorkerCallback<T> callback, {Duration? time, 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", whentime
hits, it callscallback
with the last "value" emitted. -
defaultLogWriterCallback(
String value, {bool isError = false}) → void - default logger from GetX
-
ever<
T> (RxInterface< T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker -
Called every time
listener
changes. As long as thecondition
returns true. -
everAll(
List< RxInterface> listeners, WorkerCallback callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker -
Similar to ever, but takes a list of
listeners
, the condition for thecallback
is common to alllisteners
, and thecallback
is executed to each one of them. The Worker is common to all, soworker.dispose()
will cancel all streams. -
interval<
T> (RxInterface< T> listener, WorkerCallback<T> callback, {Duration time = const Duration(seconds: 1), dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker -
Ignore all changes in
listener
duringtime
(1 sec by default) or untilcondition
is met (can be a bool expression or abool 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> (RxInterface< T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker -
once()
will execute only 1 time whencondition
is met and cancel the subscription to thelistener
stream right after that.condition
defines whencallback
is called, and can be a bool or abool Function()
.
Typedefs
-
AddSubscription<
T> = FutureOr< void> Function(LightSubscription<T> subs) - Condition = bool Function()
-
GetControllerBuilder<
T extends DisposableInterface> = Widget Function(T controller) -
GetXControllerBuilder<
T extends DisposableInterface> = Widget Function(T controller) - LogWriterCallback = void Function(String text, {bool isError})
- VoidCallback from logs
-
NotifierBuilder<
T> = Widget Function(T state) -
RemoveSubscription<
T> = FutureOr< bool?> Function(LightSubscription<T> subs) -
ValueBuilderBuilder<
T> = Widget Function(T snapshot, ValueBuilderUpdateCallback< T> updater) -
ValueBuilderUpdateCallback<
T> = void Function(T snapshot) -
ValueUpdater<
T> = T Function() - WidgetCallback = Widget Function()
-
WorkerCallback<
T> = dynamic Function(T callback)