ClipSwitch class
Toggles between two widgets with an animated clip path
Used to toggle the on/off state of a single setting.
The ClipSwitch itself does not maintain any state. Instead, when the state of the ClipSwitch changes, the widget calls the onChanged callback. Most widgets that use a ClipSwitch will listen for the onChanged callback and rebuild the ClipSwitch with a new value to toggle between widgets.
See also:
- ClipPathTransition, which drives the ClipSwitch
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ClipSwitch
Constructors
-
ClipSwitch({Key? key, required bool value, required ValueChanged<
bool> onChanged, required Widget activeWidget, required Widget inactiveWidget, Duration duration = ClipSwitch.defaultDuration, PathBuilder pathBuilder = PathBuilders.slideUp, Curve curve = Curves.linear, Clip clipBehavior = Clip.antiAlias, StackFit fit = StackFit.loose}) -
const
Properties
- activeWidget → Widget
-
The widget to show when this ClipSwitch value is
true.final - clipBehavior → Clip
-
Defaults to Clip.antiAlias.
final
- curve → Curve
-
The animation curve
final
- duration → Duration
-
The duration of the animation.
final
- fit → StackFit
-
How to size the non-positioned activeWidget and inactiveWidget.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inactiveWidget → Widget
-
The widget to show when this ClipSwitch value is
false.final - key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onChanged
→ ValueChanged<
bool> -
Called when the user taps the ClipSwitch.
final
- pathBuilder → PathBuilder
-
The path builder
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- value → bool
-
Whether this ClipSwitch is active.
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
DiagnosticsNodeobjects 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}) → 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
Constants
- defaultDuration → const Duration