SwipeTutorial class
A widget that provides an interactive swipe tutorial.
This widget wraps around any given child widget and displays a swipe tutorial overlay, guiding users on how to interact with the child widget. It supports customizing the direction of the swipe, appearance, and behavior of the tutorial overlay.
The tutorial consists of an icon indicating the swipe direction and a text instruction, both of which can be customized.
/// Usage example:
SwipeTutorial(
child: MyWidget(),
text: 'Swipe left to see more',
swipeDirection: SwipeDirection.rightToLeft,
backgroundColor: Colors.black,
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SwipeTutorial
Constructors
-
SwipeTutorial({Key? key, required Widget child, required String text, Widget? iconWidget, bool showTutorial = true, SwipeDirection swipeDirection = SwipeDirection.rightToLeft, AnimationController? animationController, Animation<
double> ? animation, TextStyle textStyle = const TextStyle(fontSize: 18, fontWeight: FontWeight.w500, color: Colors.white), Color backgroundColor = Colors.black, double? animationBoxHeight, double? animationBoxWidth, Alignment tutorialWidgetAlignment = const Alignment(0.0, 0.0), EdgeInsetsGeometry padding = const EdgeInsets.all(16)}) -
const
Properties
-
animation
→ Animation<
double> ? -
final
- animationBoxHeight → double?
-
final
- animationBoxWidth → double?
-
final
- animationController → AnimationController?
-
final
- backgroundColor → Color
-
final
- child → Widget
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- iconWidget → Widget?
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- padding → EdgeInsetsGeometry
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showTutorial → bool
-
final
- swipeDirection → SwipeDirection
-
final
- text → String
-
final
- textStyle → TextStyle
-
final
- tutorialWidgetAlignment → Alignment
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< SwipeTutorial> -
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
-
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