OnboardingStep class
Constructors
OnboardingStep ({Key ?key , required FocusNode focusNode , required String titleText , Color ?titleTextColor = defaultTextColor , TextStyle ?titleTextStyle , String bodyText = '' , TextStyle ?bodyTextStyle , Color ?bodyTextColor = defaultTextColor , TextAlign textAlign = TextAlign.start , ShapeBorder shape = const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(8.0))) , EdgeInsets margin = const EdgeInsets.all(8.0) , Color overlayColor = defaultOverlayColor , ShapeBorder overlayShape = const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(8.0))) , bool hasLabelBox = false , EdgeInsets labelBoxPadding = const EdgeInsets.all(8.0) , BoxDecoration labelBoxDecoration = const BoxDecoration() , bool hasArrow = false , bool fullscreen = true , Duration delay = Duration.zero , ArrowPosition arrowPosition = ArrowPosition.autoVertical , HitTestBehavior overlayBehavior = HitTestBehavior.opaque , StepWidgetBuilder? stepBuilder , StepPainterBuilder? stepPainterBuilder , bool showPulseAnimation = false , Color pulseInnerColor = defaultInnerPulseColor , Color pulseOuterColor = defaultOuterPulseColor , TapCallback? onTapCallback
At least a titleText or a bodyText should be provided.
Properties
arrowPosition → ArrowPosition
By default, the value used is ArrowPosition.autoVertical
final
bodyText → String
By default, the value an empty string
final
bodyTextColor → Color ?
By default, the value used is Color(0xFFFFFFFF)
final
bodyTextStyle → TextStyle ?
By default, the value is
final
delay → Duration
By default, the value used is Duration.zero
final
focusNode → FocusNode
is required
final
fullscreen → bool
By default, the value used is true
final
hasArrow → bool
By default, the value used is false
final
hashCode → int
The hash code for this object.
no setter override
hasLabelBox → bool
By default, the value is
final
key → Key ?
final
labelBoxDecoration → BoxDecoration
By default, the value is BoxDecoration()
final
labelBoxPadding → EdgeInsets
By default the value is EdgeInsets.zero
final
margin → EdgeInsets
This is the space around the Widget we want which we would clip a hole
By default, the value is EdgeInsets.all(8.0)
final
onTapCallback → TapCallback?
final
overlayBehavior → HitTestBehavior
By default, the value used is OverlayBehavior.opaque
final
overlayColor → Color
By default, the value used is Color(0xC4000000)
final
overlayShape → ShapeBorder
By default, the value is
final
pulseInnerColor → Color
By default, the value used is white
final
pulseOuterColor → Color
By default, the value used is white
final
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
shape → ShapeBorder
By default, the value is
final
showPulseAnimation → bool
By default, the value used is false
final
stepBuilder → StepWidgetBuilder?
stepBuilder is a callback function that passes the context, the title String, the actual title TextStyle,
the bodyText String and the actual bodyText TextStyle.
By default it is null. If you decide to use it you are on your own - there will be no safety measures.
If the content is too much you might get overflow error. To mitigate such issues try using SingleChildScrollView,
but remember that you will not be able to actually scroll it, as there is already an GestureDetector upper in the tree that will catch the gestures
The non full-screen overlays provide significantly smaller available space
final
stepPainterBuilder → StepPainterBuilder?
stepPainterBuilder is a callback function that passes the context, the title String, the hole Rect
and if the arrow position isTop bool.
By default it is null and it will use the LabelPainter .
You can use this to draw custom shapes around the hole. You can use the LabelPainter as a reference.
final
textAlign → TextAlign
By default, the value used is TextAlign.start
final
titleText → String
is required
final
titleTextColor → Color ?
By default, the value used is Color(0xFFFFFFFF)
final
titleTextStyle → TextStyle ?
By default, the value is
final
Methods
copyWith ({Key ?key , FocusNode ?focusNode , TextAlign ?textAlign , Color ?titleTextColor , String ?titleText , ArrowPosition ?arrowPosition , TextStyle ?titleTextStyle , String ?bodyText , Color ?bodyTextColor , TextStyle ?bodyTextStyle , BoxDecoration ?labelBoxDecoration , ShapeBorder ?shape , Color ?overlayColor , ShapeBorder ?overlayShape , EdgeInsets ?margin , EdgeInsets ?labelBoxPadding , bool ?hasLabelBox , bool ?hasArrow , bool ?fullscreen , Duration ?delay , HitTestBehavior ?overlayBehavior , StepWidgetBuilder? stepBuilder , bool ?showPulseAnimation , Color ?pulseInnerColor , Color ?pulseOuterColor , TapCallback? onTapCallback → OnboardingStep
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString ()
→ String
A string representation of this object.
override
