useInterval.md

useInterval

A declarative interval hook based on Dan Abramov's article on overreacted.io. The interval can be paused by setting the delay to null.

Installation

dependencies:
  flutter_use: ^0.0.2

Usage

class Sample extends HookWidget {
  @override
  Widget build(BuildContext context) {
    final count = useState(0);
    final delay = useState(const Duration(milliseconds: 300));
    final isRunning = useState(true);
    useInterval(
      () => count.value++,
      isRunning.value ? delay.value : null,
    );

    return Column(
      children: [
        Text("count: ${count.value}"),
        ElevatedButton(
          onPressed: () {
            isRunning.value = !isRunning.value;
          },
          child: const Text("Button"),
        ),
      ]
    );
  }
}