ScopedModel<T extends Model> class

Provides a Model to all descendants of this Widget.

Descendant Widgets can access the model by using the ScopedModelDescendant Widget, which rebuilds each time the model changes, or directly via the ScopedModel.of static method.

To provide a Model to all screens, place the ScopedModel Widget above the WidgetsApp or MaterialApp in the Widget tree.

Example

ScopedModel<CounterModel>(
  model: CounterModel(),
  child: ScopedModelDescendant<CounterModel>(
    builder: (context, child, model) => Text(model.counter.toString()),
  ),
);

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• ScopedModel

Constructors

ScopedModel({required T model, required Widget child})

Properties

child → Widget

The Widget the model will be available to.

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

model → T

The Model to provide to child and its descendants.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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}) → 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

Static Methods

of<T extends Model>(BuildContext context, {bool rebuildOnChange = false}) → T

Finds a Model provided by a ScopedModel Widget.