HintSkipReason enum
Reasons why a tour step was not shown.
A single typed enum for diagnostics instead of raw strings: testable, and an event bus can reuse the same reason values without changing the contract.
Values
- targetNotRendered → const HintSkipReason
-
The render host could not be mounted: no
OverlayStatewas reachable and no mounted target was available to capture the root overlay from. Matters for fully-deferred scenarios — passoverlay:todefaultOverlayHost. The name predates the check: it is about the overlay, not about a particular target. - timeout → const HintSkipReason
-
Wait-for-target: the target did not appear within the configured timeout.
- unknownTarget → const HintSkipReason
-
targetId is unknown to the registry and no close candidates exist (likely a typo).
- userSkipped → const HintSkipReason
-
The user skipped the tour.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- label → String
-
Kebab-case reason name for one-line diagnostics and test mapping.
no setter
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
values
→ const List<
HintSkipReason> - A constant List of the values in this enum, in order of their declaration.