A continuation of the original Flutter plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping.
| Platform | wakelock_plus support |
|---|---|
| Android | ✅ |
| iOS | ✅ |
| Web | ✅ |
| macOS | ✅ |
| Windows | ✅ |
| Linux | ✅ |
To learn more about the plugin and getting started, you can view the main package's README.
This plugin plugin uses the federated plugins approach.
Android, iOS, macOS (via Hybrid Implementation), and Web use Platform Channels in their implementations. Windows and Linux are handled through Dart-only platform implementations.
The basic API is defined using pigeon. The pigeon files can be found in the pigeons directory
in the main package. The API is defined in Dart in the wakelock_plus_platform_interface package.
The packages in this repo are the following:
| Package | Implementations |
|---|---|
wakelock_plus |
Main plugin package + Android, iOS, macOS, Windows, Linux, and Web implementations |
wakelock_plus_platform_interface |
Basic API definition & message handling |
If you want to contribute to this plugin, follow the contributing guide.
As stated before, this plugin is a continuation of the original wakelock plugin.
That plugin was originally based on screen.
Specifically, the wakelock functionality was extracted into the wakelock plugin due to lack of
maintenance by the author of the screen plugin.
For this library, the functionality remains the same as the original plugin, but has been completely refreshed (using latest Flutter standards and platform integration) with support for all six platforms currently supported by Flutter (Android, iOS, macOS, Windows, Linux, and Web).
Simply replace the import statement with the one below:
import 'package:wakelock_plus/wakelock_plus.dart';As well as replacing all the calls to Wakelock with WakelockPlus:
WakelockPlus.enable();
//...
WakelockPlus.disable();
//...
WakelockPlus.toggle(enable: true);