HintTour class

A hint tour — a declarative sequence of HintSteps.

Pure data, serializable 1-to-1 to JSON (server-driven tours later): {id, steps: [{targetId, title, ...}], stepTimeout}.

Annotations

• @immutable

Constructors

HintTour({required String id, required List<HintStep> steps, Duration stepTimeout = const Duration(seconds: 3), bool disableBackButton = false})

const

Properties

disableBackButton → bool

Block the system back button (Android back / route pop) while the tour is active, instead of letting it dismiss the app/screen mid-tour. Implemented by intercepting the route pop in the overlay host, so it works for any Flutter version (no PopScope dependency — which would also be ineffective inside an OverlayEntry anyway).

final

duplicateTargetIds → Set<String>

Duplicated step targetIds within one tour — a tour-authoring error (one tour at a time, a duplicated target is ambiguous). The check is cheap and lazy; used by the controller's start-validation.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

id → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

steps → List<HintStep>

final

stepTimeout → Duration

Default wait-for-target timeout for all steps of the tour.

final

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