flutter_tide library

Classes

BaseJsonConverter<State>
Converts a State to and from JSON.
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. [...]
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. [...]
IgnoredPersistence<State>
A persistence layer that does nothing.
Immutable
Used to annotate a class. [...]
InheritedContext<T>
A BuildContext associated to an InheritedProvider. [...]
InheritedProvider<T>
A generic implementation of an InheritedWidget. [...]
JsonConverter<State>
Converts a State to and from JSON.
JsonFilePersistence<State>
Stores the state into a file as JSON content.
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. [...]
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. [...]
PersistedStoreProvider<S>
A Store<S> that saves its state to a persistence layer on a regular base and restores it at launch. [...]
Persistence<State>
A persistence layer that allow to save and restore a state.
Provider<T>
A Provider that manages the lifecycle of the value it provides by delegating to a pair of Create and Dispose. [...]
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 [...]
Required
Used to annotate a named parameter p in a method or function f. [...]
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. [...]
ServiceLocator
A locator that allows to create external services for the current state.
Store<State>
A simple state notifier that adds support for dispatching StoreActions. [...]
StoreAction<State>
Dispatched to a Store<State> to update its state by emmiting values from the execute method.
StoreProvider<S>
StreamProvider<T>
Listens to a Stream and exposes its content to child and descendants. [...]
UseResult
See useResult for more details.
ValueListenableProvider<T>
Listens to a ValueListenable and expose its current value.

Extensions

ReadContext
Exposes the read method.
SelectContext
Adds a select method on BuildContext.
StoreProviderExtension
WatchContext
Exposes the watch method.

Constants

alwaysThrows → const _AlwaysThrows
Used to annotate a function f. Indicates that f always throws an exception. Any functions that override f, in class inheritance, are also expected to conform to this contract. [...]
_AlwaysThrows()
checked → const _Checked
Used to annotate a parameter of an instance method that overrides another method. [...]
@Deprecated('Use the `covariant` modifier instead')
_Checked()
doNotStore → const _DoNotStore
Used to annotate a method, getter or top-level getter or function to indicate that the value obtained by invoking it should not be stored in a field or top-level variable. The annotation can also be applied to a class to implicitly annotate all of the valid members of the class, or applied to a library to annotate all of the valid members of the library, including classes. If a value returned by an element marked as doNotStore is returned from a function or getter, that function or getter should be similarly annotated. [...]
_DoNotStore()
experimental → const _Experimental
Used to annotate a library, or any declaration that is part of the public interface of a library (such as top-level members, class members, and function parameters) to indicate that the annotated API is experimental and may be removed or changed at any-time without updating the version of the containing package, despite the fact that it would otherwise be a breaking change. [...]
_Experimental()
factory → const _Factory
Used to annotate an instance or static method m. Indicates that m must either be abstract or must return a newly allocated object or null. In addition, every method that either implements or overrides m is implicitly annotated with this same annotation. [...]
_Factory()
immutable → const Immutable
Used to annotate a class C. Indicates that C and all subtypes of C must be immutable. [...]
internal → const _Internal
Used to annotate a declaration which should only be used from within the package in which it is declared, and which should not be exposed from said package's public API. [...]
_Internal()
isTest → const _IsTest
Used to annotate a test framework function that runs a single test. [...]
_IsTest()
isTestGroup → const _IsTestGroup
Used to annotate a test framework function that runs a group of tests. [...]
_IsTestGroup()
literal → const _Literal
Used to annotate a const constructor c. Indicates that any invocation of the constructor must use the keyword const unless one or more of the arguments to the constructor is not a compile-time constant. [...]
_Literal()
mustCallSuper → const _MustCallSuper
Used to annotate an instance method m. Indicates that every invocation of a method that overrides m must also invoke m. In addition, every method that overrides m is implicitly annotated with this same annotation. [...]
_MustCallSuper()
nonVirtual → const _NonVirtual
Used to annotate an instance member (method, getter, setter, operator, or field) m in a class C or mixin M. Indicates that m should not be overridden in any classes that extend or mixin C or M. [...]
_NonVirtual()
optionalTypeArgs → const _OptionalTypeArgs
Used to annotate a class, mixin, extension, function, method, or typedef declaration C. Indicates that any type arguments declared on C are to be treated as optional. [...]
_OptionalTypeArgs()
protected → const _Protected
Used to annotate an instance member in a class or mixin which is meant to be visible only within the declaring library, and to other instance members of the class or mixin, and their subtypes. [...]
_Protected()
required → const Required
Used to annotate a named parameter p in a method or function f. Indicates that every invocation of f must include an argument corresponding to p, despite the fact that p would otherwise be an optional parameter. [...]
sealed → const _Sealed
Annotation marking a class as not allowed as a super-type. [...]
_Sealed()
useResult → const UseResult
Used to annotate a method, field, or getter within a class, mixin, or extension, or a or top-level getter, variable or function to indicate that the value obtained by invoking it should be use. A value is considered used if it is assigned to a variable, passed to a function, or used as the target of an invocation, or invoked (if the result is itself a function). [...]
virtual → const _Virtual
Used to annotate a field that is allowed to be overridden in Strong Mode. [...]
@Deprecated('No longer has meaning')
_Virtual()
visibleForOverriding → const _VisibleForOverriding
Used to annotate an instance member that was made public so that it could be overridden but that is not intended to be referenced from outside the defining library. [...]
_VisibleForOverriding()
visibleForTesting → const _VisibleForTesting
Used to annotate a declaration that was made public, so that it is more visible than otherwise necessary, to make code testable. [...]
_VisibleForTesting()

Typedefs

AsyncFileGetter = Future<File> Function()
Gets a file asynchronously. This is
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. [...]
Dispatcher = void Function(StoreAction action)
Trigger new actions execution from a store.
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. [...]
FromJsonConverter<State> = State Function(dynamic value)
Json deserializer for State.
Locator = T Function<T>()
A generic function that can be called to read providers, without having a reference on BuildContext. [...]
PersistedStoreInitializer<S> = Store<S> Function(BuildContext context, Store<S> store)
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)
ServiceBuilder = Object Function(Object state)
Instanciates a service for the current state.
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. [...]
StateReader<State> = State Function()
Gets the current value of a State.
ToJsonConverter<State> = dynamic Function(State state)
Json serializer for State.
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. [...]

Exceptions / Errors

ProviderNotFoundException
The error that will be thrown if Provider.of fails to find a Provider as an ancestor of the BuildContext used.