view_model_value library

Classes

ChangeNotifierProvider<T extends ChangeNotifier?>
Listens to a ChangeNotifier, expose it to its descendants and rebuilds dependents whenever ChangeNotifier.notifyListeners is called.
ChangeNotifierProxyProvider<T, R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChangeNotifierProxyProvider0<R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChangeNotifierProxyProvider2<T, T2, R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChangeNotifierProxyProvider3<T, T2, T3, R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChangeNotifierProxyProvider4<T, T2, T3, T4, R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChangeNotifierProxyProvider5<T, T2, T3, T4, T5, R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChangeNotifierProxyProvider6<T, T2, T3, T4, T5, T6, R extends ChangeNotifier?>
A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.
ChildViewModelProvider<VM extends ChangeNotifier>
ChildViewModelProvider
ChildViewModelProviderMixin<VM extends ChangeNotifier>
提供 ChildViewModelProvider 混入实现
ChildViewModelProviderWidget<VM extends ChangeNotifier>
抽象 ChildViewModelProviderWidget 提供继承功能
Consumer<T>
Obtains Provider<T> from its ancestors and passes its value to builder.
Consumer2<A, B>
Obtains Provider<T> from its ancestors and passes its value to builder.
Consumer3<A, B, C>
Obtains Provider<T> from its ancestors and passes its value to builder.
Consumer4<A, B, C, D>
Obtains Provider<T> from its ancestors and passes its value to builder.
Consumer5<A, B, C, D, E>
Obtains Provider<T> from its ancestors and passes its value to builder.
Consumer6<A, B, C, D, E, F>
Obtains Provider<T> from its ancestors and passes its value to builder.
DeferredInheritedProvider<T, R>
An InheritedProvider where the object listened is not the object emitted.
FutureProvider<T>
Listens to a Future and exposes its result to child and its descendants.
InheritedContext<T>
A BuildContext associated to an InheritedProvider.
InheritedProvider<T>
A generic implementation of an InheritedWidget.
ListenableBuilder<T extends Listenable, S>
Listenable 变化监听
ListenableProvider<T extends Listenable?>
Listens to a Listenable, expose it to its descendants and rebuilds dependents whenever the listener emits an event.
ListenableProxyProvider<T, R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListenableProxyProvider0<R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListenableProxyProvider2<T, T2, R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListenableProxyProvider3<T, T2, T3, R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListenableProxyProvider4<T, T2, T3, T4, R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListenableProxyProvider5<T, T2, T3, T4, T5, R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListenableProxyProvider6<T, T2, T3, T4, T5, T6, R extends Listenable?>
A variation of ListenableProvider that builds its value from values obtained from other providers.
ListListenableBuilder<T>
ListListenable 变化监听 ListListenable 是可监听List的包装类
MultiProvider
A provider that merges multiple providers into a single linear widget tree. It is used to improve readability and reduce boilerplate code of having to nest multiple layers of providers.
Provider<T>
A Provider that manages the lifecycle of the value it provides by delegating to a pair of Create and Dispose.
ProviderBinding
ProxyProvider<T, R>
A provider that builds a value based on other providers.
ProxyProvider0<R>
A provider that builds a value based on other providers.
ProxyProvider2<T, T2, R>
A provider that builds a value based on other providers.
ProxyProvider3<T, T2, T3, R>
A provider that builds a value based on other providers.
ProxyProvider4<T, T2, T3, T4, R>
A provider that builds a value based on other providers.
ProxyProvider5<T, T2, T3, T4, T5, R>
A provider that builds a value based on other providers.
ProxyProvider6<T, T2, T3, T4, T5, T6, R>
A provider that builds a value based on other providers.
ReassembleHandler
If you need your provider to be notified when 'Hot Reload' occurs, use this class
Selector<A, S>
An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.
Selector0<T>
A base class for custom Selector.
Selector2<A, B, S>
An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.
Selector3<A, B, C, S>
An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.
Selector4<A, B, C, D, S>
An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.
Selector5<A, B, C, D, E, S>
An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.
Selector6<A, B, C, D, E, F, S>
An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.
SingleChildBuilder
A SingleChildWidget that delegates its implementation to a callback.
SingleChildState<T extends SingleChildStatefulWidget>
A State for SingleChildStatefulWidget.
SingleChildStatefulElement
An Element that uses a SingleChildStatefulWidget as its configuration.
SingleChildStatefulWidget
A StatefulWidget that is compatible with Nested.
SingleChildStatelessElement
An Element that uses a SingleChildStatelessWidget as its configuration.
SingleChildStatelessWidget
A StatelessWidget that implements SingleChildWidget and is therefore compatible with Nested.
SingleChildWidget
A Widget that takes a single descendant.
StreamProvider<T>
Listens to a Stream and exposes its content to child and descendants.
Tuple2<T1, T2>
Represents a 2-tuple, or pair.
Tuple3<T1, T2, T3>
Represents a 3-tuple, or triple.
Tuple4<T1, T2, T3, T4>
Represents a 4-tuple, or quadruple.
Tuple5<T1, T2, T3, T4, T5>
Represents a 5-tuple, or quintuple.
Tuple6<T1, T2, T3, T4, T5, T6>
Represents a 6-tuple, or sextuple.
Tuple7<T1, T2, T3, T4, T5, T6, T7>
Represents a 7-tuple, or septuple.
ValueListenableListBuilder<T>
多个 ValueListenable 变化监听
ValueListenableProvider<T>
Listens to a ValueListenable and exposes its current value.
ValueListenableTuple2Builder<T, T2>
Tuple2
ValueListenableTuple3Builder<T, T2, T3>
Tuple3
ValueListenableTuple4Builder<T, T2, T3, T4>
Tuple4
ValueListenableTuple5Builder<T, T2, T3, T4, T5>
Tuple5
ValueListenableTuple6Builder<T, T2, T3, T4, T5, T6>
Tuple6
ValueListenableTuple7Builder<T, T2, T3, T4, T5, T6, T7>
Tuple7
ValueViewModelProvider<VM extends ChangeNotifier>
ValueViewModelProvider
ValueViewModelProviderCreate<VM>
创建 ValueListenable
ValueViewModelProviderMixin<VM extends ChangeNotifier>
提供 ValueViewModelProvider 混入实现
ValueViewModelProviderWidget<VM extends ChangeNotifier>
抽象 ValueViewModelProviderWidget 提供继承功能
ViewModelBinding<A, S>
Selector
ViewModelBinding0<T>
Selector0
ViewModelBuilder<VM extends ChangeNotifier>
根据泛型获取ViewModel
ViewModelProvider<VM extends ChangeNotifier>
ViewModelProvider
ViewModelProviderBuilder<VM>
ViewModelProviderCreate<VM>
创建 ViewModel 接口
ViewModelProviderLifecycle<VM>
ViewModelProvider 生命周期
ViewModelProviderLifecycleMixin<VM>
提供 ViewModelProviderLifecycle 混入实现
ViewModelProviderMixin<VM extends ChangeNotifier>
提供 ViewModelProvider 混入实现
ViewModelProviderWidget<VM extends ChangeNotifier>
抽象 ViewModelProviderWidget 提供继承功能
ViewModelValueBuilder<VM extends ChangeNotifier, T>
监听ViewModel中一个值变化
ViewModelValueListBuilder<VM extends ChangeNotifier, T>
监听ViewModel中多个值变化
ViewModelValueTuple2Builder<VM extends ChangeNotifier, T, T2>
监听ViewModel中Tuple2值变化
ViewModelValueTuple3Builder<VM extends ChangeNotifier, T, T2, T3>
监听ViewModel中Tuple3值变化
ViewModelValueTuple4Builder<VM extends ChangeNotifier, T, T2, T3, T4>
监听ViewModel中Tuple4值变化
ViewModelValueTuple5Builder<VM extends ChangeNotifier, T, T2, T3, T4, T5>
监听ViewModel中Tuple5值变化
ViewModelValueTuple6Builder<VM extends ChangeNotifier, T, T2, T3, T4, T5, T6>
监听ViewModel中Tuple6值变化
ViewModelValueTuple7Builder<VM extends ChangeNotifier, T, T2, T3, T4, T5, T6, T7>
监听ViewModel中Tuple7值变化

Extensions

ReadContext on BuildContext
Exposes the read method.
SelectContext on BuildContext
Adds a select method on BuildContext.
ViewModelContext on BuildContext
viewmodel extension
WatchContext on BuildContext
Exposes the watch method.

Typedefs

Create<T> = T Function(BuildContext context)
A function that creates an object of type T.
DeferredStartListening<T, R> = VoidCallback Function(InheritedContext<R?> context, void setState(R value), T controller, R? value)
A callback used to handle the subscription of controller.
Dispose<T> = void Function(BuildContext context, T value)
A function that disposes an object of type T.
ErrorBuilder<T> = T Function(BuildContext context, Object? error)
A callback used to build a valid value from an error.
Locator = T Function<T>()
A generic function that can be called to read providers, without having a reference on BuildContext.
ProviderBuilder<R> = Widget Function(BuildContext context, R value, Widget child)
ProxyProviderBuilder<T, R> = R Function(BuildContext context, T value, R? previous)
ProxyProviderBuilder2<T, T2, R> = R Function(BuildContext context, T value, T2 value2, R? previous)
ProxyProviderBuilder3<T, T2, T3, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, R? previous)
ProxyProviderBuilder4<T, T2, T3, T4, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, R? previous)
ProxyProviderBuilder5<T, T2, T3, T4, T5, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, T5 value5, R? previous)
ProxyProviderBuilder6<T, T2, T3, T4, T5, T6, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, T5 value5, T6 value6, R? previous)
ShouldRebuild<T> = bool Function(T previous, T next)
Used by providers to determine whether dependents needs to be updated when the value exposed changes
StartListening<T> = VoidCallback Function(InheritedContext<T?> element, T value)
A callback used to start the listening of an object and return a function that cancels the subscription.
UpdateShouldNotify<T> = bool Function(T previous, T current)
A function that returns true when the update from previous to current should notify listeners, if any.
ValueListWidgetBuilder<T> = Widget Function(BuildContext context, List<T> value, Widget? child)
List WidgetBuilder
ValueTuple2WidgetBuilder<T, T2> = Widget Function(BuildContext context, Tuple2<T, T2> value, Widget? child)
Tuple2 WidgetBuilder
ValueTuple3WidgetBuilder<T, T2, T3> = Widget Function(BuildContext context, Tuple3<T, T2, T3> value, Widget? child)
Tuple3 WidgetBuilder
ValueTuple4WidgetBuilder<T, T2, T3, T4> = Widget Function(BuildContext context, Tuple4<T, T2, T3, T4> value, Widget? child)
Tuple4 WidgetBuilder
ValueTuple5WidgetBuilder<T, T2, T3, T4, T5> = Widget Function(BuildContext context, Tuple5<T, T2, T3, T4, T5> value, Widget? child)
Tuple5 WidgetBuilder
ValueTuple6WidgetBuilder<T, T2, T3, T4, T5, T6> = Widget Function(BuildContext context, Tuple6<T, T2, T3, T4, T5, T6> value, Widget? child)
Tuple6 WidgetBuilder
ValueTuple7WidgetBuilder<T, T2, T3, T4, T5, T6, T7> = Widget Function(BuildContext context, Tuple7<T, T2, T3, T4, T5, T6, T7> value, Widget? child)
Tuple7 WidgetBuilder
ViewModelBindingWidgetBuilder<T> = Widget Function(BuildContext context, T value, bool isBinding, Widget? child)
WidgetBuilder
ViewModelValueList<VM, T> = List<ValueListenable<T>> Function(VM viewModel)
List
ViewModelValueListWidgetBuilder<VM, T> = Widget Function(BuildContext context, VM viewModel, List<T> value, Widget? child)
WidgetBuilder
ViewModelValueTuple2<VM, T, T2> = Tuple2<ValueListenable<T>, ValueListenable<T2>> Function(VM viewModel)
Tuple2 ValueListenable
ViewModelValueTuple2WidgetBuilder<VM, T, T2> = Widget Function(BuildContext context, VM viewModel, Tuple2<T, T2> value, Widget? child)
WidgetBuilder
ViewModelValueTuple3<VM, T, T2, T3> = Tuple3<ValueListenable<T>, ValueListenable<T2>, ValueListenable<T3>> Function(VM viewModel)
Tuple3 ValueListenable
ViewModelValueTuple3WidgetBuilder<VM, T, T2, T3> = Widget Function(BuildContext context, VM viewModel, Tuple3<T, T2, T3> value, Widget? child)
WidgetBuilder
ViewModelValueTuple4<VM, T, T2, T3, T4> = Tuple4<ValueListenable<T>, ValueListenable<T2>, ValueListenable<T3>, ValueListenable<T4>> Function(VM viewModel)
Tuple4 ValueListenable
ViewModelValueTuple4WidgetBuilder<VM, T, T2, T3, T4> = Widget Function(BuildContext context, VM viewModel, Tuple4<T, T2, T3, T4> value, Widget? child)
WidgetBuilder
ViewModelValueTuple5<VM, T, T2, T3, T4, T5> = Tuple5<ValueListenable<T>, ValueListenable<T2>, ValueListenable<T3>, ValueListenable<T4>, ValueListenable<T5>> Function(VM viewModel)
Tuple5 ValueListenable
ViewModelValueTuple5WidgetBuilder<VM, T, T2, T3, T4, T5> = Widget Function(BuildContext context, VM viewModel, Tuple5<T, T2, T3, T4, T5> value, Widget? child)
WidgetBuilder
ViewModelValueTuple6<VM, T, T2, T3, T4, T5, T6> = Tuple6<ValueListenable<T>, ValueListenable<T2>, ValueListenable<T3>, ValueListenable<T4>, ValueListenable<T5>, ValueListenable<T6>> Function(VM viewModel)
Tuple6 ValueListenable
ViewModelValueTuple6WidgetBuilder<VM, T, T2, T3, T4, T5, T6> = Widget Function(BuildContext context, VM viewModel, Tuple6<T, T2, T3, T4, T5, T6> value, Widget? child)
WidgetBuilder
ViewModelValueTuple7<VM, T, T2, T3, T4, T5, T6, T7> = Tuple7<ValueListenable<T>, ValueListenable<T2>, ValueListenable<T3>, ValueListenable<T4>, ValueListenable<T5>, ValueListenable<T6>, ValueListenable<T7>> Function(VM viewModel)
Tuple7 ValueListenable
ViewModelValueTuple7WidgetBuilder<VM, T, T2, T3, T4, T5, T6, T7> = Widget Function(BuildContext context, VM viewModel, Tuple7<T, T2, T3, T4, T5, T6, T7> value, Widget? child)
WidgetBuilder
ViewModelValueWidgetBuilder<VM, T> = Widget Function(BuildContext context, VM viewModel, T value, Widget? child)
WidgetBuilder
ViewModelWidgetBuilder<VM> = Widget Function(BuildContext context, VM viewModel, Widget? child)
WidgetBuilder
ViewModelWidgetCallback<VM> = void Function(BuildContext context, VM viewModel)
WidgetBuilder
ViewModelWidgetChange<VM> = void Function(BuildContext context, VM viewModel, VM? oldViewModel)
WidgetBuilder

Exceptions / Errors

ProviderNotFoundException
The error that will be thrown if Provider.of fails to find a Provider as an ancestor of the BuildContext used.
ProviderNullException
Called Provider.of<T> instead of Provider.of<T?> but the provider returned null.