StateProvider class

It allows you to access the current state of your widgets along with the search results. For instance, you can use this component to create results/no results or query/no query pages.

Examples Use(s):

• perform side-effects based on the results states of various widgets.
• render custom UI based on the current state of app.

For example,

StateProvider(
 subscribeTo: {
   'author-filter': [KeysToSubscribe.Value]
 },
 onChange: (next, prev) {
   print("Next state");
   print(next['author-filter']?.va
   print("Prev state");
   print(prev['author-filter']?.value);
 },
 build: (searchState) {
   var results =
       searchState['result-widget']?.results?.numberOfResults;

   if (results != null) {
     return Text("results" + results.toString());
   }
   return Text("results" + "empty");
 },
)
```dart

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• StateProvider

Constructors

StateProvider({Map<String, List<KeysToSubscribe>>? subscribeTo, void onChange(Map<String, SearchControllerState>, Map<String, SearchControllerState>)?, Widget build(Map<String, SearchControllerState>)?, Key? key})

Properties

build → (Widget Function(Map<String, SearchControllerState>)?)

It is used for rendering a custom UI based on updated state For example,

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

onChange → (void Function(Map<String, SearchControllerState>, Map<String, SearchControllerState>)?)

Callback function, is a callback function called when the search state changes and accepts the previous and next search state as arguments. For example,

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subscribeTo → Map<String, List<KeysToSubscribe>>?

A map of widget ids and list of properties to subscribe to.

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → _StateProviderState

Creates the mutable state for this widget at a given location in the tree.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited