IntroStepBuilder class

Inheritance

Constructors

IntroStepBuilder({Key? key, required int order, required Widget builder(BuildContext context, GlobalKey<State<StatefulWidget>> key), String? text, Widget overlayBuilder(StepWidgetParams params)?, BorderRadiusGeometry? borderRadius, VoidCallback? onHighlightWidgetTap, EdgeInsets? padding, VoidCallback? onWidgetLoad, String group = 'default'})
const

Properties

borderRadius BorderRadiusGeometry?
Widget borderRadius of the selected area, the default is BorderRadius.all(Radius.circular(4))
final
builder Widget Function(BuildContext context, GlobalKey<State<StatefulWidget>> key)
final
group String
Set the group of this step, default is 'default'
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onHighlightWidgetTap VoidCallback?
When highlight widget is tapped
final
onWidgetLoad VoidCallback?
When widget loaded (means the key is add to context)
final
order int
Establish a running sequence where lower values take precedence for execution.
final
overlayBuilder → (Widget Function(StepWidgetParams params)?)
The method of generating the content of the guide page, which will be called internally by Intro when the guide page appears. And will pass in some parameters on the current page through StepWidgetParams
final
padding EdgeInsets?
Widget padding of the selected area, the default is EdgeInsets.all(8)
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
text String?
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<IntroStepBuilder>
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.
override
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