hotspot library

Getting started with the hotspot tour guide feature:

  1. put HotspotProvider at the top of your widget tree
  2. OPTIONAL: give it an actionBuilder for controls
  3. annotate widgets to highlight and explain with HotspotTarget
  4. call HotspotProvider.of(context).startFlow()

This feature will highlight your HotspotTargets and provide an animated and interactive dialog with more information.

Classes

CalloutActionController
HotspotActionBuilder
HotspotProvider
Example of a typical HotspotProvider with actionBuilder handling the progress dots, dismiss button, and next button.
HotspotProviderState
HotspotTarget
Example of a page that has multiple hotspot targets.
HotspotTargetState

Extensions

WithHotspotX on Widget

Typedefs

CalloutActionBuilder = Widget Function(BuildContext context, CalloutActionController controller)
A function that contains all the data needed to build the action section of a callout body.