BlocProviderTree class

A Flutter Widget that merges multiple BlocProvider widgets into one widget tree.

BlocProviderTree improves the readability and eliminates the need to nest multiple BlocProviders.

By using BlocProviderTree we can go from:

BlocProvider<BlocA>(
  creator: (_context, _bag) => BlocA(),
  child: BlocProvider<BlocB>(
    creator: (_context, _bag) => BlocB(),
    child: BlocProvider<BlocC>(
      creator: (_context, _bag) => BlocC(),
      child: ChildA(),
    )
  )
)

to:

BlocProviderTree(
  blocProviders: [
    BlocProvider<BlocA>(creator: (_context, _bag) => BlocA()),
    BlocProvider<BlocB>(creator: (_context, _bag) => BlocB()),
    BlocProvider<BlocC>(creator: (_context, _bag) => BlocC()),
  ],
  child: ChildA(),
)

BlocProviderTree converts the BlocProvider list into a tree of nested BlocProvider widgets. As a result, the only advantage of using BlocProviderTree is improved readability due to the reduction in nesting and boilerplate.

Inheritance

Constructors

BlocProviderTree({Key? key, required List<BlocProvider<Bloc>> blocProviders, required Widget child})
const

Properties

blocProviders List<BlocProvider<Bloc>>
The BlocProvider list which is converted into a tree of BlocProvider widgets.
final
child Widget
The Widget and its descendants which will have access to every BloC provided by blocProviders.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
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}) 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