TutorialCoachMark class

Constructors

TutorialCoachMark({required List<TargetFocus> targets, Color colorShadow = Colors.black, FutureOr<void> onClickTarget(TargetFocus)?, FutureOr<void> onClickTargetWithTapPosition(TargetFocus, TapDownDetails)?, FutureOr<void> onClickOverlay(TargetFocus)?, dynamic onFinish()?, double paddingFocus = 10, bool onSkip()?, AlignmentGeometry alignSkip = Alignment.bottomRight, String textSkip = "SKIP", TextStyle textStyleSkip = const TextStyle(color: Colors.white), bool hideSkip = false, bool useSafeArea = true, double opacityShadow = 0.8, Duration focusAnimationDuration = const Duration(milliseconds: 600), Duration unFocusAnimationDuration = const Duration(milliseconds: 600), Duration pulseAnimationDuration = const Duration(milliseconds: 500), bool pulseEnable = true, Widget? skipWidget, bool showSkipInLastTarget = true, ImageFilter? imageFilter, int initialFocus = 0})

Properties

alignSkip AlignmentGeometry
final
colorShadow Color
final
focusAnimationDuration Duration
final
hashCode int
The hash code for this object.
no setterinherited
hideSkip bool
final
imageFilter ImageFilter?
final
initialFocus int
final
isShowing bool
no setter
onClickOverlay → (FutureOr<void> Function(TargetFocus)?)
final
onClickTarget → (FutureOr<void> Function(TargetFocus)?)
final
onClickTargetWithTapPosition → (FutureOr<void> Function(TargetFocus, TapDownDetails)?)
final
onFinish → (dynamic Function()?)
final
onSkip → (bool Function()?)
final
opacityShadow double
final
paddingFocus double
final
pulseAnimationDuration Duration
final
pulseEnable bool
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showSkipInLastTarget bool
final
skipWidget Widget?
final
targets List<TargetFocus>
final
textSkip String
final
textStyleSkip TextStyle
final
unFocusAnimationDuration Duration
final
useSafeArea bool
final
widgetKey GlobalKey<TutorialCoachMarkWidgetState>
no setter

Methods

finish() → void
goTo(int index) → void
next() → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
previous() → void
show({required BuildContext context, bool rootOverlay = false}) → void
showWithNavigatorStateKey({required GlobalKey<NavigatorState> navigatorKey, bool rootOverlay = false}) → void
showWithOverlayState({required OverlayState overlay, bool rootOverlay = false}) → void
skip() → void
toString() String
A string representation of this object.
inherited

Operators

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