Skip to content

lukepighetti/flutter_hotspot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hotspot

The simplest way to make beautiful tours, coachmarks, and tutorials.

demo of under, critically, and over damped Flutter curves

Wrap your app, screen, or view with HotspotProvider

class HomeScreen extends StatelessWidget {
  const HomeScreen({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const HotspotProvider(
      child: Scaffold(
        body: // ...
      ),
    );
  }
}

Add hotspot callouts to your widget tree

class Example extends StatelessWidget {
  const Example({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return IconButton(
      icon: const Icon(Icons.play_arrow),
      onPressed: () {
        // ...
      },
    ).withHotspot(
      order: 1,
      title: 'Tour It!',
      text: 'This is the first callout in the tour!',
    );
  }
}

Start a flow

HotspotProvider.of(context).startFlow()

About

Simple tours, coachmarks, and tutorials. Just tag your Widgets!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages