BlocProvider<T extends StateStreamableSource<Object?>> class

Takes a Create function that is responsible for creating the Bloc or Cubit and a child which will have access to the instance via BlocProvider.of(context). It is used as a dependency injection (DI) widget so that a single instance of a Bloc or Cubit can be provided to multiple widgets within a subtree.

BlocProvider(
  create: (BuildContext context) => BlocA(),
  child: ChildA(),
);

It automatically handles closing the instance when used with Create. By default, Create is called only when the instance is accessed. To override this behavior, set lazy to false.

BlocProvider(
  lazy: false,
  create: (BuildContext context) => BlocA(),
  child: ChildA(),
);

Inheritance

Object
DiagnosticableTree
Widget
StatelessWidget
SingleChildStatelessWidget
BlocProvider

Implemented types

Widget

Available extensions

WidgetX

Constructors

BlocProvider({required Create<T> create, Key? key, Widget? child, bool lazy = true}): Takes a Create function that is responsible for creating the Bloc or Cubit and a child which will have access to the instance via BlocProvider.of(context). It is used as a dependency injection (DI) widget so that a single instance of a Bloc or Cubit can be provided to multiple widgets within a subtree.
const
BlocProvider.value({required T value, Key? key, Widget? child}): Takes a value and a child which will have access to the value via BlocProvider.of(context). When BlocProvider.value is used, the Bloc or Cubit will not be automatically closed. As a result, BlocProvider.value should only be used for providing existing instances to new subtrees.
const

Properties

center → Widget: Available on Widget, provided by the WidgetX extension

no setter
child → Widget?: Widget which will have access to the Bloc or Cubit.
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: Whether the Bloc or Cubit should be created lazily. Defaults to true.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

align(Alignment alignment) → Widget: Available on Widget, provided by the WidgetX extension
build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
inherited
buildWithChild(BuildContext context, Widget? child) → Widget: A build method that receives an extra child parameter.
override
createElement() → SingleChildStatelessElement: 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.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
pad(double pad) → Widget: Available on Widget, provided by the WidgetX extension
pOnly({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Widget: Available on Widget, provided by the WidgetX extension
pxy({double x = 0, double y = 0}) → Widget: Available on Widget, provided by the WidgetX extension
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
visible({required bool isVisible, Widget replacer = const SizedBox.shrink()}) → Widget: Available on Widget, provided by the WidgetX extension

Operators

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

Static Methods

of<T extends StateStreamableSource<Object?>>(BuildContext context, {bool listen = false}) → T: Method that allows widgets to access a Bloc or Cubit instance as long as their BuildContext contains a BlocProvider instance.