ViewState<T extends ViewModel, W extends StatefulWidget> class abstract

Base state for MVVM views.

ViewState manages the lifecycle connection between a StatefulWidget and its ViewModel. It automatically:

Sets the ViewModel as active/inactive based on widget lifecycle
Responds to app lifecycle changes (background/foreground)
Disposes the ViewModel when the widget is disposed

This allows you to have full control of the view lifecycle, useful when you need to override lifecycle methods (didUpdateWidget, didChangeDependencies, etc.) or manage complex view logic like animations, controllers, or mixins. For more simple use cases, consider using ViewWidget.

Example:

class _CounterViewState extends ViewState<CounterViewModel, CounterView> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Watch(
        viewModel.counter,
        builder: (context, value) => Text('$value'),
      ),
    );
  }
}

Constructors

ViewState()

Properties

context → BuildContext: The location in the tree where this widget builds.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
mounted → bool: Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
viewModel → T: The ViewModel instance associated with this ViewState.
latefinal
widget → W: The current configuration.
no setterinherited

Methods

activate() → void: Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
inherited
deactivate() → void: Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
didChangeAccessibilityFeatures() → void: Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void: Synchronizes ViewModel.isActive with app lifecycle state. If you need to override, be sure to call super.didChangeAppLifecycleState.
override
didChangeDependencies() → void: Called when a dependency of this State object changes.
inherited
didChangeLocales(List<Locale>? locales) → void: Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void: Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void: Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void: Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void: Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void: Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>: Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>: Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>: Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>: Called when a request is received from the system to exit the application.
inherited
didUpdateWidget(covariant W oldWidget) → void: Called whenever the widget configuration changes.
inherited
dispose() → void: Called when this object is removed from the tree permanently.
handleCancelBackGesture() → void: Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void: Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool: Called at the start of a predictive back gesture.
inherited
handleStatusBarTap() → void: Called when the user taps the status bar on iOS, to scroll a scroll view to the top.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void: Called when a predictive back gesture moves.
inherited
initState() → void: Called when this object is inserted into the tree.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
reassemble() → void: Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
resolveViewModel() → T: Creates the ViewModel instance to be used by this ViewState. By default, it retrieves the ViewModel from the service locator. Override this method to provide a custom ViewModel instance using a different method. e.g. GetIt, Provider, Constructor injection etc.
setState(VoidCallback fn) → void: Notify the framework that the internal state of this object has changed.
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
toStringShort() → String: A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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

ViewState<T extends ViewModel, W extends StatefulWidget> class abstract

Constructors

Properties

Methods

Operators

mvvm_kit library