CoreSwitch class

A customizable switch widget that supports different types, labels, and colors.

The CoreSwitch provides three distinct types:

Normal: Standard toggle switch with grey styling
Lock: Security switch with red styling for lock/unlock states
Imperial: Unit system switch with green styling for imperial/metric toggle

Basic Usage

// Simple switch without labels
CoreSwitch(
  value: isEnabled,
  onChanged: (value) => setState(() => isEnabled = value),
)

Switch with Labels

// Normal switch with custom labels
CoreSwitch(
  type: CoreSwitchType.normal,
  value: isPrivate,
  onChanged: (value) => setState(() => isPrivate = value),
  activeLabel: 'Public',
  inactiveLabel: 'Private',
)

Lock Switch

// Security lock switch
CoreSwitch(
  type: CoreSwitchType.lock,
  value: isLocked,
  onChanged: (value) => setState(() => isLocked = value),
  activeLabel: 'Lock',
  inactiveLabel: 'Unlock',
)

Imperial Switch

// Unit system toggle
CoreSwitch(
  type: CoreSwitchType.imperial,
  value: useImperial,
  onChanged: (value) => setState(() => useImperial = value),
  activeLabel: 'Metric',
  inactiveLabel: 'Imperial',
)

Custom Colors

// Switch with custom inactive color
CoreSwitch(
  value: isCustom,
  onChanged: (value) => setState(() => isCustom = value),
  inactiveColor: Colors.purple,
)

value is the current state of the switch (true = active/on, false = inactive/off). onChanged is the callback function when the switch is toggled. type determines the switch's visual style and default colors. activeLabel is the text displayed when the switch is in the active state. inactiveLabel is the text displayed when the switch is in the inactive state. inactiveColor overrides the default inactive color for the switch type.

Inheritance

Constructors

CoreSwitch({Key? key, required bool value, required ValueChanged<bool> onChanged, CoreSwitchType type = CoreSwitchType.normal, String? activeLabel, String? inactiveLabel, Color? inactiveColor}): const

Properties

activeLabel → String?: final
hashCode → int: The hash code for this object.
no setterinherited
inactiveColor → Color?: final
inactiveLabel → String?: final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onChanged → ValueChanged<bool>: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
type → CoreSwitchType: final
value → bool: 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.
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