mustafa-707 / unlock_detector

A Flutter Package to detect if app running while phone is locked or not

Unlock Detector Plugin for Flutter

This Flutter plugin allows you to detect screen lock and unlock events on both Android and iOS devices.

Features

• Detect when the screen is locked or unlocked.

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  unlock_detector:

Sure, here is a more detailed and explanatory version of the README usage section:

---

Usage

To get started with the Unlock Detector package, follow these steps:

1. Set up a listener for the lock/unlock stream:

   Use the stream property to listen for changes in the lock/unlock status. The stream provides real-time updates whenever the device's lock state changes.

   String _status = 'Unknown'; // Initial status
   
    UnlockDetector.stream.listen((event) {
     setState(() {
       _status = event; // Update status with the latest event
     });
   });

2. Display the lock/unlock status in your UI:

   Use the _status variable to display the current lock/unlock status in your app's UI. In this example, the status is displayed in the center of the screen.

 ...
        body: Center(
          child: Text('Lock/Unlock Status: $_status'),
        ),
          ...

Support

If you find this plugin helpful, consider supporting me: