SwitchStore<S, A> class

A widget that renders different content based on the runtime type of the store's state.

Useful when your state is a sealed class hierarchy and each variant should render a different widget.

Example

SwitchStore<AuthState, AuthAction>(
  store: authStore,
  typeMap: {
    LoggedIn: (context, store) => HomeScreen(store: store),
    LoggedOut: (context, store) => LoginScreen(store: store),
  },
);

Fluent API

SwitchStore(store: store)
  .when<LoggedIn>((ctx, store) => HomeScreen(store: store))
  .when<LoggedOut>((ctx, store) => LoginScreen(store: store));

Inheritance

Constructors

SwitchStore({Key? key, required Store<S, A> store, Map<Type, dynamic> typeMap = const {}, Widget orElse(BuildContext context)?}): Creates a SwitchStore with a type-to-builder mapping.
const

Properties

hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
orElse → Widget Function(BuildContext context)?: Fallback widget when no type matches.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
store → Store<S, A>: The store whose state type determines which builder is used.
final
typeMap → Map<Type, dynamic>: Map from Type to builder function.
final

Methods

build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement: Creates a StatelessElement to manage this widget's location in the tree.
inherited
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, int wrapWidth = 65}) → 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
when<T>(Widget builder(BuildContext context, Store<T, A> store)) → SwitchStore<S, A>: Adds a type mapping using a fluent API.

Operators

operator ==(Object other) → bool: The equality operator.
inherited