in_app_idle_detector 0.0.1 copy "in_app_idle_detector: ^0.0.1" to clipboard
in_app_idle_detector: ^0.0.1 copied to clipboard

A Flutter plugin to detect user inactivity (idle) across all platforms.

Pub Version License Platform

πŸ’€ in_app_idle_detector #

A lightweight Flutter plugin that detects user inactivity (idle state) across all platforms: Android, iOS, Web, Windows, macOS, and Linux.

Perfect for banking apps, secure dashboards, or any app that needs to react when the user goes idle.


✨ Features #

  • πŸ”„ Detect inactivity after custom timeout
  • πŸ‘¨β€πŸ’» Keyboard, mouse, touch & app lifecycle supported
  • πŸ–₯️ Cross-platform (Android, iOS, Web, Desktop)
  • ⏱️ Remaining time tracking
  • πŸ› οΈ Lightweight – no native code
  • πŸ” Ideal for auto logout, lock screen, and productivity

πŸ“¦ Installation #

dependencies:
  in_app_idle_detector: ^0.0.1

Working Demo #

DEMO DEMO DEMO DEMO

πŸ§‘β€πŸ’» Usage #

  1. Initialize the plugin (e.g. inside main())
void main() {
  runApp(MyApp());

  InAppIdleDetector.initialize(
    timeout: Duration(seconds: 10), // Set your own duration
    onIdle: () {
      // Called when user goes idle
      print("User is idle");
    },
    onActive: () {
      // Called when user becomes active again
      print("User is active");
    },
  );
}
  1. Show a dialog or take action on idle
showDialog(
  context: navigatorKey.currentContext!,
  builder: (_) => AlertDialog(
    title: Text("Idle Warning"),
    content: Text("You've been inactive for 10 seconds."),
    actions: [
      TextButton(
        onPressed: () {
          Navigator.of(navigatorKey.currentContext!).pop();
        },
        child: Text("Dismiss"),
      ),
    ],
  ),
);
  1. Extra API (Pause / Resume / Reset)
InAppIdleDetector.pause();  // Stop tracking temporarily
InAppIdleDetector.resume(); // Resume tracking
InAppIdleDetector.reset();  // Manually reset idle timer
  1. Get Remaining Time
final timeLeft = InAppIdleDetector.remainingTime;
final idleStatus = InAppIdleDetector.isIdle;

βœ… Use Cases #

πŸ”’ Auto-logout after inactivity (e.g., in banking apps)

πŸ” Lock screen on desktops after idle

⏱️ Countdown timers for session expiration

πŸ“‰ Inactivity analytics and user behavior tracking

πŸ§ͺ Platform Support #

Platform Supported
βœ… Android Yes
βœ… iOS Yes
βœ… Web Yes
βœ… Windows Yes
βœ… macOS Yes
βœ… Linux Yes

πŸ“š API Summary #

Method Description initialize(...) Starts the idle detection system reset() Resets the timer (e.g. after activity) pause() Temporarily disables tracking resume() Resumes tracking isIdle Returns true if currently idle remainingTime Returns Duration until next idle trigger

πŸ’‘ Tips #

Always use navigatorKey.currentContext for dialogs to ensure it works from anywhere. You can build a visual countdown using remainingTime and a Timer.periodic.

Support the Project #

If you find this plugin helpful, consider supporting its development:

Your support is greatly appreciated!

Bugs/Requests #

Feel free to open an issue if you encounter any problems or think that the plugin is missing some feature.

sheth02parth1299@gmail.com

πŸ™Œ Author #

Created by Parth Sheth 🧠 Contributions, stars, and feedback are welcome!