counter_reference
library
Classes
-
CounterReference<T extends GetxService>
-
-
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- with builder method you return the widget to build.
2- with methods desktop, tablet,phone, watch. the specific
method will be built when the screen type matches the method
when the screen is ScreenType.Tablet the tablet method
will be exuded and so on.
Note if you use this method please set the
property alwaysUseBuilder to false
With settings 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 use Rx 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.
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", 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, WorkerCallback<T> callback, {dynamic 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, {dynamic 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>(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 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, WorkerCallback<T> callback, {dynamic 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().
