OnboardingTooltip class
Widget that displays an onboarding tooltip with description and action buttons.
The tooltip appears near the highlighted target widget and can be positioned above, below, or at the center of the screen.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- OnboardingTooltip
Constructors
- OnboardingTooltip({Key? key, required Rect targetRect, required bool showAbove, required bool isLastStep, required OnboardingStep step, required VoidCallback onNext, required VoidCallback onSkip, void onLayout(Path combinedPath)?, String nextText = 'OK', String skipText = 'Skip', String finishText = 'Finish'})
-
Creates an onboarding tooltip.
const
Properties
- finishText → String
-
Text displayed on the finish button (last step). Defaults to 'Finish'.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isLastStep → bool
-
Whether this is the last step in the onboarding flow.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- nextText → String
-
Text displayed on the next/confirm button. Defaults to 'OK'.
final
- onLayout → void Function(Path combinedPath)?
-
Optional callback that provides the tooltip's path for spotlight cutouts.
final
- onNext → VoidCallback
-
Callback invoked when the user taps the "Next" or "OK" button.
final
- onSkip → VoidCallback
-
Callback invoked when the user taps the "Skip" button.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showAbove → bool
-
Whether to show the tooltip above the target (true) or below (false).
final
- skipText → String
-
Text displayed on the skip button. Defaults to 'Skip'.
final
- step → OnboardingStep
-
The onboarding step configuration.
final
- targetRect → Rect
-
The screen rectangle of the target widget being highlighted.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< OnboardingTooltip> -
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