get_state_manager/get_state_manager library
Library providing state management utilities using Refreshed.
Classes
-
Bind<
T> - Abstract class representing a binding widget responsible for managing a specific type of controller.
-
BindElement<
T> - The BindElement is responsible for injecting dependencies into the widget tree so that they can be observed.
-
Binder<
T> - An inherited widget that updates its dependents when the controller sends notifications.
-
Binding<
T> -
Binding should be extended.
When using
GetMaterialApp
, allGetPage
s and navigation methods (like Get.to()) have abinding
property that takes an instance of Bindings to manage the dependencies() (via Get.put()) for the Route you are opening. -
Binds<
S> - A widget responsible for managing a list of bindings and providing them to its child widget.
-
CustomStatus<
T> - A custom status indicating that the state is in a custom state.
-
EmptyStatus<
T> - A status indicating that the state is empty.
-
ErrorStatus<
T, S> - A status indicating that the state has encountered an error.
- FullLifeCycleController
- A controller with super lifecycles (including native lifecycles).
-
GetBuilder<
T extends GetxController> - A widget that builds itself based on the latest value of a GetxController.
-
GetListenable<
T> -
A class that provides listenable behavior similar to
ValueNotifier
. -
GetNotifier<
T> - A class representing a state notifier with a Get lifecycle.
-
GetStatus<
T> - Represents the status of an asynchronous operation, such as loading, error, empty, success, or custom.
-
GetView<
T> - GetView is a great way of quickly access your Controller without having to call Get.find
-
GetWidget<
S extends GetLifeCycleMixin> - GetWidget is a great way of quickly access your individual Controller without having to call Get.find
-
GetX<
T extends GetLifeCycleMixin> - A widget that manages the lifecycle of a GetX controller and rebuilds its child widget whenever the controller's state changes.
- GetxController
- Abstract class representing a GetX controller.
-
GetXState<
T extends GetLifeCycleMixin> - The state for the GetX widget.
- ListNotifier
- ListNotifierGroup
- A Notifier with a group of listeners identified by id
- ListNotifierSingle
- A Notifier with single listeners
-
LoadingStatus<
T> - A status indicating that the state is currently loading.
- Notifier
- A class responsible for managing notifications and listeners.
- NotifyData
- Data class containing information about notifications and listeners.
- Observer
- An experimental widget that rebuilds when observed reactive variables change.
- Obx
- A reactive widget that rebuilds whenever the observed state changes.
- ObxElement
- A wrapper around a StatelessElement that enables observation of changes in the stateless widget's reactive dependencies.
- ObxStatelessWidget
- A stateless widget that can listen to reactive changes.
-
ObxValue<
T extends RxInterface> - A reactive widget similar to Obx, but manages a local state. Pass the initial data in the constructor. This is useful for simple local states, like toggles, visibility, themes, button states, etc.
- ObxWidget
- The base class for all GetX reactive widgets. This class is used as a foundation for widgets that react to changes in GetX observables.
- RxController
- A clean controller to be used with only Rx variables.
-
StateController<
T> - A recommended way to use Getx with Future fetching.
-
SuccessStatus<
T> -
A status indicating that the state has been successfully updated with data of type
T
. -
SuperController<
T> - A controller with super lifecycles (including native lifecycles) and StateMixins.
-
Value<
T> -
A class similar to
ValueNotifier
with additional state management capabilities. -
ValueBuilder<
T> - A widget that manages local state like ObxValue, but uses a callback instead of a reactive value.
-
ValueBuilderState<
T> - The state associated with the ValueBuilder widget.
Mixins
- FullLifeCycleMixin
- Mixin that provides a full lifecycle implementation for 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. - ListNotifierGroupMixin
- ListNotifierSingleMixin
- This mixin adds to Listenable the addListener, removeListener, and containsListener implementations.
- ScrollMixin
- Mixin to manage scroll events when the scroll position is at the top or bottom.
- StatelessObserverComponent
- A mixin that provides functionality for observing reactive changes in a StatelessElement.
-
StateMixin<
T> - A mixin that provides state management capabilities.
Extensions
- StateAccessExtension on BuildContext
- Extension methods for accessing state in the context of a widget build.
-
StateExtension
on StateMixin<
T> - Extension methods for the StateMixin class.
-
StatusDataExtension
on GetStatus<
T> - Extension methods for the GetStatus class.
Typedefs
- Disposer = void Function()
- This callback removes the listener when called.
-
GetControllerBuilder<
T extends GetLifeCycleMixin> = Widget Function(T controller) -
Signature for a function that builds a widget with a controller of type
T
. - GetStateUpdate = void Function()
- Replaces StateSetter, returning whether the Widget is mounted for extra validation. If this brings overhead, consider removing the extra call.
-
GetXControllerBuilder<
T extends GetLifeCycleMixin> = Widget Function(T controller) - A typedef for a function that builds a widget based on a GetX controller.
-
InitBuilder<
T> = T Function() -
Signature for a function that creates an object of type
T
. -
NotifierBuilder<
T> = Widget Function(T state) - A builder function for creating widgets based on a state.
-
ValueBuilderBuilder<
T> = Widget Function(T snapshot, ValueBuilderUpdateCallback< T> updater) - A function that builds a widget based on the current value and an updater function.
-
ValueBuilderUpdateCallback<
T> = void Function(T snapshot) - A callback function that is called when the ValueBuilder updates its value.
- WidgetCallback = Widget Function()
- Callback signature for a widget builder function.
Exceptions / Errors
-
BindError<
T> - A class representing an error encountered during binding resolution.