FSwitch class
A control that allows the user to toggle between checked and unchecked.
Typically used to toggle the on/off state of a single setting.
See:
- https://forui.dev/docs/switch for working examples.
- FSwitchStyle for customizing a switch's appearance.
- Inheritance
Constructors
-
FSwitch({FSwitchStyle? style, Widget? label, Widget? description, Widget? error, String? semanticLabel, bool value = false, ValueChanged<
bool> ? onChange, bool enabled = true, bool autofocus = false, FocusNode? focusNode, ValueChanged<bool> ? onFocusChange, DragStartBehavior dragStartBehavior = DragStartBehavior.start, Key? key}) -
Creates a FSwitch.
const
Properties
- autofocus → bool
-
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
- description → Widget?
-
The description displayed below the label.
final
- dragStartBehavior → DragStartBehavior
-
Determines the way that drag start behavior is handled.
final
- enabled → bool
-
Whether this checkbox is enabled. Defaults to true.
final
- error → Widget?
-
The error displayed below the description.
final
- focusNode → FocusNode?
-
An optional focus node to use as the focus node for this widget.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → Widget?
-
The label displayed next to the checkbox.
final
-
onChange
→ ValueChanged<
bool> ? -
Called when the user toggles the switch on or off.
final
-
onFocusChange
→ ValueChanged<
bool> ? -
Handler called when the focus changes.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
The semantic label used by accessibility frameworks.
final
- style → FSwitchStyle?
-
The style. Defaults to FThemeData.switchStyle.
final
- value → bool
-
The current value of the checkbox.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
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.
override
-
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}) → 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