https://github.com/mrrhak/screen_lock_detector
A Flutter plugin that enables your app to detect screen lock and unlock events across Android and iOS platforms. The plugin provides native event callbacks for both Android and iOS, making it easy to respond to lock screen changes â such as pausing sensitive activities, logging out users, or triggering background operations.
https://github.com/mrrhak/screen_lock_detector
device-lock lockscreen screen-lock screen-lock-detector
Last synced: about 2 months ago
JSON representation
A Flutter plugin that enables your app to detect screen lock and unlock events across Android and iOS platforms. The plugin provides native event callbacks for both Android and iOS, making it easy to respond to lock screen changes â such as pausing sensitive activities, logging out users, or triggering background operations.
- Host: GitHub
- URL: https://github.com/mrrhak/screen_lock_detector
- Owner: mrrhak
- License: mit
- Created: 2025-10-13T07:58:23.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-10-14T06:32:55.000Z (6 months ago)
- Last Synced: 2025-10-14T07:12:46.350Z (6 months ago)
- Topics: device-lock, lockscreen, screen-lock, screen-lock-detector
- Language: Dart
- Homepage: https://mrrhak.com
- Size: 1.11 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
ðŠī Screen Lock Detector ðŠī
A Flutter plugin that enables your app to detect screen lock and unlock events across Android and iOS platforms.
The plugin provides native event callbacks for both Android and iOS, making it easy to respond to lock screen changes â such as pausing sensitive activities, logging out users, or triggering background operations.
---
## How it's work?
For iOS, this plugin just listen to `UIApplication` notification center API:
- `protectedDataWillBecomeUnavailableNotification` to detect is **locked**
- `protectedDataDidBecomeAvailableNotification` to detect is **unlocked**
For Android, this plugin uses `KeyguardManager` and `PowerManager` API to check if device is secured lock or display is off combine with listener on `Intent` actions:
- `ACTION_SCREEN_OFF` to detect is **locked**
- `ACTION_USER_PRESENT` to detect is **unlocked**
## Features
- â
Detect when the screen is locked.
- â
Detect when the screen is unlocked.
- â
Supports both event streams and manual status checks.
- â
Works on Android and iOS.
> **Note**
> This plugin does not work on simulators or emulators because it relies on native system events that are not available in these virtual environments. Please test on a physical device.
## Installation
Add `screen_lock_detector` as a dependency in your `pubspec.yaml` file:
```sh
flutter pub add screen_lock_detector
```
## Usage
### Import Plugin
```dart
import 'package:screen_lock_detector/screen_lock_detector.dart';
```
### Listen to Event Stream
```dart
ScreenLockDetector.statusStream.listen((status) {
print("Screen status: $status");
if (status == ScreenStatus.locked) {
// Do something here when screen is locked
} else if (status == ScreenStatus.unlocked) {
// Do something here when screen is unlocked
}
});
```
### Or Manual Status Check
```dart
final status = await ScreenLockDetector.checkScreenStatus();
print("Screen status: $status");
```
See the [example](https://github.com/mrrhak/screen_lock_detector/tree/master/example) for runnable examples of various usages.
## Bugs or Requests
If you encounter any problems feel free to open an [issue](https://github.com/mrrhak/screen_lock_detector/issues/new?template=bug_report.md). If you feel the library is missing a feature, please raise a [ticket](https://github.com/mrrhak/screen_lock_detector/issues/new?template=feature_request.md) on GitHub and I'll look into it. Pull request are also welcome.
See [Contributing.md](https://github.com/mrrhak/screen_lock_detector/blob/master/CONTRIBUTING.md).
## Support
Don't forget to give it a like ð or a star â
## Activities
