ToggleController class
A controller for managing toggle state in toggle buttons and switches.
ToggleController extends ValueNotifier to provide reactive state management for boolean toggle values. It implements ComponentController to integrate with the shadcn_flutter form system and provides convenient methods for programmatic state changes.
The controller maintains a boolean value representing the toggle state and notifies listeners when the state changes, making it suitable for use with toggle buttons, switches, and other binary state controls.
Example:
final toggleController = ToggleController(false);
// Listen to changes
toggleController.addListener(() {
print('Toggle state: ${toggleController.value}');
});
// Toggle the state programmatically
toggleController.toggle();
// Set specific value
toggleController.value = true;
- Inheritance
-
- Object
- ChangeNotifier
- ValueNotifier<
bool> - ToggleController
- Mixed-in types
Constructors
- ToggleController.new([bool value = false])
- Creates a ToggleController with an initial toggle state.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- value ↔ bool
-
The current value stored in this notifier.
getter/setter pairinherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
toggle(
) → void - Toggles the current boolean state.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited