HintStep class
A single tour step — data, not a widget.
Two content paths: zero-config (title/description, rendered by the
default tooltip from HintTheme) and custom (tooltipBuilder, the
full-customization ladder). tooltipBuilder is the only widget-typed slot
in the contract — a deliberate exception to allow fully replacing a tooltip.
- Annotations
Constructors
- HintStep({required String targetId, String? title, String? description, TooltipPosition position = TooltipPosition.auto, Duration? waitTimeout, bool showSkip = true, Widget tooltipBuilder(BuildContext context, HintStep step, HintTooltipContext ctx)?})
-
const
Properties
- description → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- position → TooltipPosition
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showSkip → bool
-
Whether the default tooltip shows a "Skip" button on this step.
final
- targetId → String
-
Key in the target registry — not a GlobalKey.
final
- title → String?
-
Zero-config title/description; ignored when tooltipBuilder is set.
final
- tooltipBuilder → Widget Function(BuildContext context, HintStep step, HintTooltipContext ctx)?
-
Fully custom tooltip. Receives the step itself (styling by targetId)
and a HintTooltipContext — actions for buttons plus the position in
the tour (index/count, "is last step").
final
- waitTimeout → Duration?
-
Wait-for-target timeout for this step; null — inherits HintTour.stepTimeout.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resolveTimeout(
Duration fallback) → Duration - The step's timeout, honoring inheritance.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited