Skip to main content

guided_tutor 0.2.0 copy "guided_tutor: ^0.2.0" to clipboard
guided_tutor: ^0.2.0 copied to clipboard

A dependency-free guided-tour overlay for Flutter: a scrim spotlights one widget at a time with a caption explaining it.

0.2.0 #

  • GuidedTour.show(context: ..., steps: ...): the lite way to run a tour — no Stack, no showTour state of your own, no GuidedTourLabels to write by hand. Inserts the tour into the root Overlay and removes itself again when it closes.
  • GuidedTourLabels.standard(): English chrome ("Next"/"Back"/"Skip"/"Done", a "N/M" counter) as a built-in default. GuidedTour.labels is no longer required — it defaults to this.
  • README rewritten as a proper get-started-in-a-minute tutorial, with a preview GIF of a real tour running on this package.
  • example/ now shows both hosting styles side by side: the AppBar's lightning-bolt icon calls GuidedTour.show, the floating action button hosts GuidedTour in a Stack the long way.

0.1.0 #

Initial release.

  • GuidedTour: a scrim with one widget spotlighted through it, walking a List<GuidedTourStep>. Skips steps whose target isn't currently in the tree, scrolls a target into view (and waits for layout/scroll to settle) before measuring it, and is modal — a "Skip" link is always on screen, and the system back gesture leaves the tour rather than the screen under it.
  • GuidedTourStep / GuidedTourLabels: the step model and the tour's own chrome strings, both supplied by the caller — no bundled copy or locale.
  • GuidedTourStyle: every colour, size, and duration the tour draws with, every field optional and derived from the ambient Theme when unset.
  • TourAnchors<T> / TourAnchorScope<T>: generic GlobalKey plumbing for wiring up anchors without a screen needing to know a tour exists.
1
likes
160
points
69
downloads

Documentation

API reference

Publisher

unverified uploader

Weekly Downloads

A dependency-free guided-tour overlay for Flutter: a scrim spotlights one widget at a time with a caption explaining it.

Homepage
Repository (GitHub)
View/report issues

License

MIT (license)

Dependencies

flutter

More

Packages that depend on guided_tutor