FLUTTER ECOSYSTEM

lukepighetti/flutter_hotspot

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

flutter_hotspot project cover
Stars
146
Forks
22
Last push (UTC)
Jun 28, 2024
Project status
Active
Luke Pighetti GitHub avatar
GITHUB User

Luke Pighetti ↗

Mobile engineer

ProspectBangor, ME
LanguagesDartSwiftKotlinObjective-C

Packages published by this repository

Dependencies used

Dependency list 3 items
  • flutter{"sdk":"flutter"}
  • provider^6.1.2
  • flutter_testDevelopment{"sdk":"flutter"}

Original README

English project snapshot. Visit GitHub for the latest content.

Expand / collapse project README

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()