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, 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.
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.
FullController<T>
A controller with both state management and lifecycle observation capabilities.
FullLifeCycleController
Alias for LifecycleController to maintain backward compatibility.
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<AwesomeController>() yourself.
GetWidget<S extends GetLifeCycleMixin>
GetWidget is a great way of quickly access your individual Controller without having to call Get.find<AwesomeController>() yourself. Get save you controller on cache, so, you can to use Get.create() safely GetWidget is perfect to multiples instance of a same controller. Each GetWidget will have your own controller, and will be call events as onInit and onClose when the controller get in/get out on memory.
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
Base controller class that provides state management capabilities. This is the foundation for all other controllers.
GetxScrollController
A controller for managing scroll events at the top and bottom of scrollable content. Provides automatic handling of scroll edge detection with debouncing.
GetXState<T extends GetLifeCycleMixin>
LifecycleController
A controller with full app lifecycle observation capabilities.
ListNotifier
A notifier that supports both single and grouped listeners.
ListNotifierGroup
A Notifier that supports a group of listeners identified by an ID.
ListNotifierSingle
A Notifier that supports 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 lightweight controller designed for use with reactive (Rx) variables.
StateController<T>
A controller with state management capabilities for async operations.
SuccessStatus<T>
A status indicating that the state has been successfully updated with data of type T.
SuperController<T>
Alias for FullController to maintain backward compatibility.
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

AppLifecycleMixin
Mixin that provides app lifecycle observation capabilities. This separates the app lifecycle logic from the controller hierarchy.
FullLifeCycleMixin
Mixin that provides backward compatibility with the old lifecycle implementation.
GetSingleTickerProviderStateMixin
Mixin to provide a single ticker for GetxControllers. Works like SingleTickerProviderMixin but optimized for GetX.
GetTickerProviderStateMixin
Mixin to provide multiple tickers for GetxControllers. Works like TickerProviderMixin but optimized for GetX.
ListNotifierGroupMixin
A mixin for managing a group of listeners identified by an ID.
ListNotifierSingleMixin
This mixin adds listener management capabilities to Listenable.
ScrollMixin
Alias for GetxScrollController to maintain backward compatibility.
StatelessObserverComponent
A mixin that provides functionality for observing reactive changes in a StatelessElement.
StateMixin<T>
A mixin that provides state management capabilities.
UpdateMixin
Mixin that provides update capabilities for controllers. This separates the update logic from the controller base class.

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.