FeatureProvider<F extends Feature> class

A provider widget for managing and exposing a Feature to the widget tree.

FeatureProvider allows you to create or provide an existing Feature instance and makes it available to its descendants in the widget tree using the FeatureProvider.of method.

Usage

There are two ways to use FeatureProvider:

  1. Create Mode: Instantiate a Feature dynamically:

    FeatureProvider.create(
      create: (context) => MyFeature(...),
      child: MyWidget(),
    );
    
  2. Value Mode: Provide an existing Feature instance:

    FeatureProvider.value(
      value: myFeatureInstance,
      child: MyWidget(),
    );
    

Key Parameters

  • F: The type of the Feature.
  • S: The type of the state managed by the feature.
  • M: The type of messages handled by the feature.
  • E: The type of effects emitted by the feature.
Inheritance
Annotations
  • @experimental

Constructors

FeatureProvider.create({required CreateFeature<F> create, required Widget child, bool lazy = false, Key? key})
Creates a FeatureProvider using a factory function.
const
FeatureProvider.value({required F value, required Widget child, bool lazy = false, Key? key})
Creates a FeatureProvider with an existing Feature instance.
const

Properties

child Widget
The widget subtree that will have access to the Feature.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lazy bool
If true, the Feature will only be instantiated when first accessed. Defaults to false.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

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

Operators

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

Static Methods

of<F extends Feature>(BuildContext context, {bool listen = false}) → F
Retrieves the nearest Feature of type F from the widget tree.