get_state_manager library

Classes

Bindings
Bindings should be extended or implemented. When using GetMaterialApp, all GetPages and navigation methods (like Get.to()) have a binding property that takes an instance of Bindings to manage the dependencies() (via Get.put()) for the Route you are opening.
BindingsBuilder<T>
Simplifies Bindings generation from a single callback. To avoid the creation of a custom Binding instance per route. [...]
DisposableInterface
GetBuilder<T extends GetxController>
GetImplXState<T extends DisposableInterface>
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
GetLifeCycle
GetState<T>
It's Experimental class, the Api can be change
GetStatelessElement
GetStatelessWidget<T extends DisposableInterface>
GetView<T>
GetView is a great way of quickly access your Controller without having to call Get.find [...]
GetWidget<T extends DisposableInterface>
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().
MixinBuilder<T extends GetxController>
Obx
The simplest reactive widget in GetX. [...]
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, ),
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.
RxBool
Rx class for bool Type.
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<T> uses in all it's subclass.
RxList<E>
Create a list similar to List<T>
RxMap<K, V>
RxNum
RxSet<E>
RxState<T>
It's Experimental class, the Api can be change
RxString
Rx class for String Type.
SimpleBuilder
TaskManager
Value<T>
This is a experimental feature. Meant to be used with SimpleBuilder, it auto-registers the variable like Rx() does with Obx().
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value. [...]
Worker

Mixins

GetStateUpdaterMixin<T extends StatefulWidget>
Complies with GetStateUpdater [...]
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
SingleGetTickerProviderMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController. [...]

Extensions

BoolExtension
DoubleExtension
Inst
IntExtension
ListExtension
MapExtension
RxT
SetExtension
StringExtension

Properties

Get → _GetImpl
final
getObs RxInterface
global object that registers against GetX and Obx, and allows the reactivity of those Widgets and Rx values.
read / write

Functions

debounce<T>(RxInterface<T> listener, dynamic callback(T), {Duration time}) 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
default logger from GetX
ever<T>(RxInterface<T> listener, dynamic callback(T), {dynamic condition = true}) Worker
Called every time listener changes. As long as the condition returns true. [...]
everAll(List<RxInterface> listeners, dynamic callback(dynamic), {dynamic condition = true}) 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>(RxInterface<T> listener, dynamic callback(T), {Duration time = const Duration(seconds: 1), dynamic condition = true}) 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>(RxInterface<T> listener, dynamic callback(T), {dynamic condition}) 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(). [...]

Enums

RxStatus
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.onlyBuilders 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.

Typedefs

AsyncInstanceBuilderCallback<S> = Future<S> Function()
BindingBuilderCallback = void Function()
GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GetStateUpdate = void Function()
GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
InstanceBuilderCallback<S> = S Function()
LogWriterCallback = void Function(String text, {bool isError})
Voidcallback from logs
ValueBuilderBuilder<T> = Widget Function(T snapshot, ValueBuilderUpdateCallback<T> updater)
ValueBuilderUpdateCallback<T> = void Function(T snapshot)
WidgetCallback = Widget Function()