data_widget library

Classes

CapturedData
CapturedData holds all the data captured from another context.
ChangeListener
An interface to provide a way to notify listeners.
Data<T>
A widget that provides the data to its descendants.
DataBuilder<T>
A widget that receives the data from the ancestor Data widget.
DataHolder<T>
An interface that holds forwardable data.
DataMessenger<T>
DataMessenger is a widget that holds the forwardable data. The data is attached/received from the ForwardableData widget and then passed to the descendants. DataMessenger<T> can only store ForwardableData<T>.
DataMessengerRoot
DataMessengerRoot is the root of the data messenger tree. The root stores all kinds of forwardable data and provides them to the descendants.
DataNotifier<T>
A widget that passes value from a ValueListenable to its descendants. The data is refreshed when the ValueListenable changes.
DebounceController
A controller to debounce or throttle a callback.
ForwardableData<T>
A widget that holds the data that can be attached to ancestor holders.
ForwardableDataState<T>
FutureWidgetBuilder<T>
A widget that builds itself based on the latest snapshot of interaction with
InheritedDataHolder<T>
An InheritedWidget that passes the DataHolder to its descendants.
InheritedDataHolderWidget<T>
An abstract InheritedWidget that passes the DataHolder to its descendants.
InheritedRootDataHolder
An InheritedWidget that passes the root DataHolder to its descendants.
ListChangeDetails<T>
A list change details containing the added, removed, and index of the changes.
ListListenable<T>
A list that can be listened to for changes.
ListNotifier<T>
A list that can be listened to for changes and notifies listeners when the list changes.
MapChangeDetails<K, V>
A map change details containing the added and removed entries.
MapListenable<K, V>
A map that can be listened to for changes.
MapNotifier<K, V>
A map that can be listened to for changes and notifies listeners when the map changes.
MappedValueNotifier<T, R>
A ValueListenable that maps the value of another ValueListenable.
Model<T>
A widget that provides the model to its descendants.
ModelBoundary<T>
A widget that stops the property of the given type from being passed to its descendants.
ModelBuilder<T>
A widget that uses the model to build a widget.
ModelKey<T>
A ModelKey that holds the data key and provides methods to find and change the data.
ModelListenable<T>
A widget that provides the model to its descendants and listens to the data changes. The data is refreshed when the ValueListenable changes. The model is read-only.
ModelNotifier<T>
A widget that provides the model to its descendants and listens to the data changes. The data is refreshed when the ValueNotifier changes.
MultiData
A widget that provides multiple data to its descendants.
MultiDataItem
An internal interface that provides dataType and wrap method.
MultiModel
A widget that provides multiple models to its descendants.
MutableNotifier<T>
A notifier class that allows mutable updates and notifies listeners of changes.
SetChangeDetails<T>
A set change details containing the added and removed elements.
SetListenable<T>
A set that can be listened to for changes.
SetNotifier<T>
A set notifier class that allows mutable updates and notifies listeners of changes.
ValueChangeNotifier<T>
A value notifier class that notifies listeners of changes.
ValueNotifierUnmodifiableView<T>
A read-only view of a ValueListenable.
VoidChangeListener
A callback that takes no arguments and returns no data.

Mixins

AlwaysUpdateData
A mixin that always returns true for shouldNotify. Which means the data will always notify the listeners regardless of the changes.
ChangesNotifierHelperMixin
A mixin that provides a way to notify listeners.
DistinctData
A mixin that provides a shouldNotify method to determine if the data has changed and should notify the listeners.
ModelProperty<T>
A mixin for all kinds of Model properties.
MultiModelItem

Extensions

ValueChangeNotifierExtension on ValueChangeNotifier<T>
Extension on ValueChangeNotifier to provide a read-only view and mapping.
ValueListenableExtension on ValueListenable<T>
Extension on ValueListenable to provide a read-only view and mapping.
ValueNotifierExtension on ValueNotifier<T>
Extension on ValueNotifier to provide a read-only view.

Typedefs

DataWidgetBuilder<T> = Widget Function(BuildContext context, T data, Widget? child)
A widget builder that receives the data from the ancestor Data widget.
DebounceCallback<T> = FutureOr<T> Function()
A callback to be debounced or throttled.
DebounceErrorConsumer = void Function(Object error, StackTrace stackTrace)
A callback to be called when the debounced or throttled callback throws an error.
DebounceResultConsumer<T> = void Function(T value)
A callback to be called when the debounced or throttled callback is called.
FutureWidgetBuilderCallback<T> = Widget Function(BuildContext context, T value)
A callback to be called when the future is completed with a value.
FutureWidgetBuilderEmptyCallback = Widget Function(BuildContext context)
A callback to be called when the future is completed with no data.
FutureWidgetBuilderErrorCallback = Widget Function(BuildContext context, Object error, StackTrace stackTrace)
A callback to be called when the future is completed with an error.
FutureWidgetBuilderLoadingCallback = Widget Function(BuildContext context)
A callback to be called when the future is still loading.
ListChangeListener<T> = void Function(ListChangeDetails<T> details)
A callback that receives a ListChangeDetails object.
MapChangeListener<K, V> = void Function(MapChangeDetails<K, V> details)
A callback that receives a MapChangeDetails object.
ModelWidgetBuilder<T> = Widget Function(BuildContext context, ModelProperty<T> model, Widget? child)
A callback that takes the model and returns a widget.
OptionalDataWidgetBuilder<T> = Widget Function(BuildContext context, T? data, Widget? child)
A widget builder that receives the data (that may be null) from the ancestor
SetChangeListener<T> = void Function(SetChangeDetails<T> details)
A set that can be listened to for changes and notifies listeners when the set changes.
ValueChangeListener<T> = void Function(T value, T previous)
A callback that receives a value and the previous value.