ViewModelGadget<T> class

A Gadget that encapsulates and handles the state of a view model.

During initialization, the view-model object T is automatically registered into the ObservableModel.

If the subscribeToViewModel property is true, the ViewModelGadget registers itself as a subscriber for the specified view-model: in this way, eventual changes to the view-model object can trigger the builder function, effectively updating the UI.

ViewModelGadget<MyViewModel>(
  viewModel: MyViewModel(),
  subscribeToViewModel: true,
  builder: (context, viewModel) => Column(
    children: [
      Text('${viewModel.someText}'),
      Text('${viewModel.otherText}'),
    ]
  )
)

Otherwise, SubscriberGadgets can be used in order to register some specific widgets to the view-model (or some properties of it).

ViewModelGadget<MyViewModel>(
  viewModel: MyViewModel(),
  builder: (context, viewModel) => Column(
    children: [
      SubscriberGadget<MyViewModel>(
        propertiesSelector: (viewModel) => [viewModel.someText]
        builder: (_, viewModel) => Text('${viewModel.someText}')
      ),
      SubscriberGadget<MyViewModel>(
        propertiesSelector: (viewModel) => [viewModel.otherText]
        builder: (_, viewModel) => Text('${viewModel.otherText}')
      ),
    ]
  )
)

When the widget is disposed, the view-model object T is automatically removed from the ObservableModel and the optional dispose callback is executed. The dispose callback can be used to manually dispose stateful components of the given view-model object (like a TextEditingController).

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• ViewModelGadget

Constructors

ViewModelGadget({Key? key, required CreateViewModel<T> create, required ViewModelGadgetBuilder<T> builder, DisposeViewModel<T>? dispose, bool subscribeToViewModel = false})

const

Properties

builder → ViewModelGadgetBuilder<T>

final

create → CreateViewModel<T>

final

dispose → DisposeViewModel<T>?

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

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subscribeToViewModel → bool

final

Methods

createElement() → StatefulElement

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

inherited

createState() → _ViewModelGadgetState<T>

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