discontinuedPackage refreshed has been discontinued and replaced by getxify.

Bind<T> class abstract

Abstract class representing a binding widget responsible for managing a specific type of controller.

Inheritance
Implemented types

Constructors

Bind({required Widget? child, Key? key, InitBuilder<T>? init, bool global = true, bool autoRemove = true, bool assignId = false, void initState(BindElement<T> state)?, Object filter(T value)?, String? tag, dynamic dispose(BindElement<T> state)?, Object? id, dynamic didChangeDependencies(BindElement<T> state)?, void didUpdateWidget(Binder<T> oldWidget, BindElement<T> state)?})
Constructs a Bind widget.
const
Bind.builder({Widget? child, InitBuilder<T>? init, InstanceCreateBuilderCallback<T>? create, bool global = true, bool autoRemove = true, bool assignId = false, Object filter(T value)?, String? tag, Object? id, void initState(BindElement<T> state)?, void dispose(BindElement<T> state)?, void didChangeDependencies(BindElement<T> state)?, void didUpdateWidget(Binder<T> oldWidget, BindElement<T> state)?})
Factory method to create a Bind widget using a builder pattern.
factory

Properties

assignId → bool
Flag indicating whether an identifier should be assigned to the widget.
final
autoRemove → bool
Flag indicating whether the widget should be automatically removed when disposed.
final
child → Widget?
Child widget that will receive the provided bindings.
final
didChangeDependencies → dynamic Function(BindElement<T> state)?
Callback function that is called when the widget's dependencies change.
final
didUpdateWidget → void Function(Binder<T> oldWidget, BindElement<T> state)?
Callback function that is called when the widget is updated.
final
dispose → dynamic Function(BindElement<T> state)?
Callback function that is called when the widget is disposed.
final
filter → Object Function(T value)?
Function to filter the value of the controller.
final
global → bool
Flag indicating whether the controller should be treated as global.
final
hashCode → int
The hash code for this object.
no setterinherited
id → Object?
Identifier for the widget.
final
init → InitBuilder<T>?
Function to initialize the controller.
final
initState → void Function(BindElement<T> state)?
Callback function that is called when the widget is initialized.
final
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
tag → String?
Tag for the widget.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
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

delete<S>({String? tag, bool force = false}) → Future<bool>
Deletes a dependency from the GetX service locator using the specified tag.
deleteAll({bool force = false}) → Future<void>
Deletes all dependencies from the GetX service locator.
factory<S>(InstanceBuilderCallback<S> builder, {bool autoRemove = true, bool assignId = true, String? tag}) → Bind<S>
Creates a binding with a custom factory function.
find<S>({String? tag}) → S
Retrieves a dependency from the GetX service locator using the specified tag.
isPrepared<S>({String? tag}) → bool
Checks if a dependency is prepared in the GetX service locator using the specified tag.
isRegistered<S>({String? tag}) → bool
Checks if a dependency is registered in the GetX service locator using the specified tag.
lazyPut<S>(InstanceBuilderCallback<S> builder, {String? tag, bool fenix = false, VoidCallback? onClose}) → Bind<S>
Creates a lazy binding and registers a builder function in the GetX service locator.
lazyReplace<P>(InstanceBuilderCallback<P> builder, {String? tag, bool? fenix}) → Future<void>
Lazily replaces an existing dependency with a new builder function.
of<T>(BuildContext context, {bool rebuild = false}) → T
Retrieves the dependency of type T from the nearest ancestor Binder widget.
put<S>(S dependency, {String? tag, bool permanent = false}) → Bind<S>
Creates a binding and puts the specified dependency into the GetX service locator.
reload<S>({String? tag, String? key, bool force = false}) → void
Reloads a dependency from the GetX service locator using the specified tag.
reloadAll({bool force = false}) → void
Reloads all dependencies from the GetX service locator.
replace<P>(P child, {String? tag}) → Future<void>
Replaces an existing dependency with a new instance.
spawn<S>(InstanceBuilderCallback<S> builder, {String? tag, bool permanent = true}) → Bind<S>
Creates a binding and puts the specified dependency into the GetX service locator with a custom lifecycle.