ShadSwitchFormField class

Inheritance
Available extensions

Constructors

ShadSwitchFormField({String? id, Key? key, FormFieldSetter<bool>? onSaved, String? forceErrorText, Widget? label, Widget error(String error)?, Widget? description, void onChanged(bool)?, @Deprecated('Use toValueTransformer instead') ToValueTransformer<bool?>? valueTransformer, ToValueTransformer<bool?>? toValueTransformer, FromValueTransformer<bool?>? fromValueTransformer, VoidCallback? onReset, bool enabled = true, AutovalidateMode? autovalidateMode, String? restorationId, required bool initialValue, ShadDecoration? decoration, FocusNode? focusNode, String? validator(bool)?, Color? thumbColor, Color? uncheckedTrackColor, Color? checkedTrackColor, double? width, double? margin, Duration? duration, Widget? inputLabel, Widget? inputSublabel, EdgeInsetsGeometry? padding, TextDirection? direction})

Properties

autovalidateMode → AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → FormFieldBuilder<bool>
Function that returns the widget representing this form field.
finalinherited
decorationBuilder → ShadDecoration? Function(BuildContext context)?
A function that builds a custom ShadDecoration for the field. Overrides the default decoration; merged with error state if provided.
finalinherited
description → Widget?
The description widget displayed below the field. Typically a Text widget, offering additional field information.
finalinherited
enabled → bool
Whether the form is able to receive user input.
finalinherited
error → Widget Function(String error)?
A function that returns a custom error widget based on the error text. Called when validation fails; defaults to a Text widget if null.
finalinherited
errorBuilder → FormFieldErrorBuilder?
Function that returns the widget representing the error to display.
finalinherited
focusNode → FocusNode?
The focus node for keyboard navigation and focus handling. If null, an internal focus node is created by the state.
finalinherited
forceErrorText → String?
An optional property that forces the FormFieldState into an error state by directly setting the FormFieldState.errorText property without running the validator function.
finalinherited
fromValueTransformer → FromValueTransformer<bool?>?
A function to transform a value into the field’s expected type. Useful for converting data before populating the field; defaults to null (no transformation).
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String?
An optional identifier used to reference the field within a ShadForm. Enables form data retrieval or field manipulation post-submission.
finalinherited
initialValue → bool?
An optional value to initialize the form field to, or null otherwise.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → Widget?
The label widget displayed above the field. Typically a Text widget, providing context for the field’s purpose.
finalinherited
onChanged → ValueChanged<bool?>?
Callback invoked when the field’s value changes. Provides the new value, complementing form state updates.
finalinherited
onReset → VoidCallback?
Callback invoked when the field is reset to its initial value. Allows additional reset logic; defaults to null.
finalinherited
onSaved → ValueChanged<bool?>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
readOnly → bool
Whether the field is read-only. Defaults to false; if true, prevents editing but allows focus.
finalinherited
restorationId → String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
toValueTransformer → ToValueTransformer<bool?>?
A function to transform the field’s value before saving or processing. Useful for formatting or converting data; defaults to null (no transformation).
finalinherited
validator → FormFieldValidator<bool>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited
valueTransformer → ToValueTransformer<bool?>?
A function to transform the field’s value before saving or processing. Useful for formatting or converting data; defaults to null (no transformation).
finalinherited

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → ShadFormBuilderFieldState<ShadSwitchFormField, bool>
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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
positionedWith(ShadPosition position) → Widget

Available on Widget, provided by the PositionedExt 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

Operators

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