in_app_idle_detector 0.0.1
in_app_idle_detector: ^0.0.1 copied to clipboard
A Flutter plugin to detect user inactivity (idle) across all platforms.
๐ค 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 #
๐งโ๐ป Usage #
- 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");
},
);
}
- 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"),
),
],
),
);
- Extra API (Pause / Resume / Reset)
InAppIdleDetector.pause(); // Stop tracking temporarily
InAppIdleDetector.resume(); // Resume tracking
InAppIdleDetector.reset(); // Manually reset idle timer
- 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.
๐ Author #
Created by Parth Sheth ๐ง Contributions, stars, and feedback are welcome!