gesture_debouncer 0.0.3

Created simple widget that can act as debouncer to absorb certain gestures according to the cooldowns/futures.

example/lib/main.dart

import 'dart:developer';
import 'package:flutter/material.dart';
import 'package:fluttericon/font_awesome_icons.dart';
import 'package:gesture_debouncer/gesture_debouncer.dart';
import 'package:overlay_support/overlay_support.dart';

void main() {
  runApp(const MyApp());
}

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

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return OverlaySupport.global(
      toastTheme: ToastThemeData(
        background: Colors.indigo,
        textColor: Colors.white,
      ),
      child: MaterialApp(
        title: 'Gesture Debouncer',
        theme: ThemeData(
          primarySwatch: Colors.indigo,
          primaryColor: Colors.indigo,
        ),
        home: const HomePage(),
      ),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  bool liked = false;
  bool liked2 = false;
  double iconSize = 45;

  Widget _getIconWidget(onPressed) {
    return IconButton(
      icon: Icon(liked ? FontAwesome.heart : FontAwesome.heart_empty),
      iconSize: iconSize,
      color: liked ? Colors.red : Colors.grey,
      onPressed: onPressed,
    );
  }

  Widget _getDoubleClickWidget(onPressed) {
    return GestureDetector(
      onDoubleTap: onPressed,
      child: Icon(
        liked2 ? FontAwesome.heart : FontAwesome.heart_empty,
        size: iconSize,
        color: liked2 ? Colors.green : Colors.grey,
      ),
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        centerTitle: true,
        title: const Text(
          "Gesture Debouncer",
          style: TextStyle(fontSize: 15),
        ),
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        crossAxisAlignment: CrossAxisAlignment.stretch,
        children: [
          Column(
            mainAxisSize: MainAxisSize.min,
            children: [
              const Text(
                "Single click detector",
                style: TextStyle(color: Colors.red),
              ),
              GestureDebouncer(
                cooldownAfterExecution: const Duration(seconds: 2),
                cooldownBuilder: (BuildContext ctx, _) {
                  return Stack(
                    alignment: AlignmentDirectional.center,
                    children: [
                      _getIconWidget(() {
                        if (liked) {
                          toast("You have recently liked this");
                        } else {
                          toast("You have recently unliked this");
                        }
                      }),
                      IgnorePointer(
                        // Used so that main icon gets the click event
                        child: Icon(
                          Icons.lock_outline,
                          color: liked ? Colors.white : Colors.grey,
                          size: iconSize / 3,
                        ),
                      ),
                    ],
                  );
                },
                onError: (e) {
                  log(e.toString());
                },
                builder:
                    (BuildContext ctx, Future<void> Function()? onGesture) {
                  return _getIconWidget(onGesture);
                },
                onGesture: () async {
                  setState(() {
                    liked = !liked;
                  });
                  await Future.delayed(const Duration(seconds: 2), () {});
                },
              ),
            ],
          ),
          const SizedBox(height: 50),
          Column(
            mainAxisSize: MainAxisSize.min,
            children: [
              const Text(
                "Double click detector",
                style: TextStyle(color: Colors.green),
              ),
              GestureDebouncer(
                cooldownAfterExecution: const Duration(seconds: 2),
                cooldownBuilder: (BuildContext ctx, _) {
                  return Stack(
                    alignment: AlignmentDirectional.center,
                    children: [
                      _getDoubleClickWidget(() {
                        if (liked2) {
                          toast("You have recently liked this (double click)");
                        } else {
                          toast(
                              "You have recently unliked this (double click)");
                        }
                      }),
                      IgnorePointer(
                        // Used so that main icon gets the click event
                        child: Icon(
                          Icons.lock_outline,
                          color: liked2 ? Colors.white : Colors.grey,
                          size: iconSize / 3,
                        ),
                      ),
                    ],
                  );
                },
                onError: (e) {
                  log(e.toString());
                },
                builder:
                    (BuildContext ctx, Future<void> Function()? onGesture) {
                  return _getDoubleClickWidget(onGesture);
                },
                onGesture: () async {
                  setState(() {
                    liked2 = !liked2;
                  });
                  await Future.delayed(const Duration(seconds: 2), () {});
                },
              ),
            ],
          ),
        ],
      ),
    );
  }
}