TSwitch class

A toggle switch input with validation support.

TSwitch provides a Material Design switch with:

  • Optional label text
  • Validation support
  • Custom colors and sizes
  • Disabled state
  • Value binding with ValueNotifier

Basic Usage

TSwitch(
  label: 'Enable notifications',
  value: true,
  onValueChanged: (value) => print('Switch: \$value'),
)

With ValueNotifier

final notificationsEnabled = ValueNotifier<bool>(false);

TSwitch(
  label: 'Notifications',
  valueNotifier: notificationsEnabled,
)

See also:

Inheritance
Mixed-in types
Available extensions

Constructors

TSwitch({Key? key, bool? value = false, ValueNotifier<bool?>? valueNotifier, ValueChanged<bool?>? onValueChanged, FocusNode? focusNode, String? label, String? tag, String? helperText, String? info, bool isRequired = false, List<String? Function(bool?)>? rules, Duration? validationDebounce, bool autoFocus = false, bool disabled = false, Color? color, Color? inactiveColor, TInputSize? size = TInputSize.md, TInputFieldTheme? theme})
const

Properties

autoFocus → bool
Whether the switch should auto-focus.
final
clearable → bool
Whether the field shows a clear button when it has a value.
final
color → Color?
Custom color for the switch when active/on.
final
disabled → bool
Whether the switch is disabled.
final
focusNode → FocusNode?
Custom focus node.
final
hashCode → int
The hash code for this object.
no setterinherited
helperText → String?
Helper text displayed below the field.
final
inactiveColor → Color?
Custom color for the switch when inactive/off.
final
info → String?
The info text (optional).
final
isRequired → bool
Whether this switch is required.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → String?
Label text displayed next to the switch.
final
onTap → VoidCallback?
Callback for tap events.
final
onValueChanged → ValueChanged<bool?>?
Callback fired when the value changes.
final
rules → List<String? Function(bool?)>?
Validation rules for the switch value.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → TInputSize?
The size of the switch.
final
tag → String?
An optional tag displayed next to the label.
final
theme → TInputFieldTheme?
Custom theme.
final
validationDebounce → Duration?
Debounce duration for validation.
final
value → bool?
The current value of the switch.
final
valueNotifier → ValueNotifier<bool?>?
A ValueNotifier for two-way binding.
final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TSwitch>
Creates the mutable state for this widget at a given location in the tree.
override
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
estimateWidth(BuildContext context) → double

Available on TSwitch, provided by the TSwitchWidthX extension

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.
paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.
size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.
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
validateValue(bool? value) → List<String>
Validates the given value against the rules.
inherited
visible(bool visible, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.
when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

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