wakelock_plus - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #llm #golang #android #linux #nodejs #windows #cli #vue #pytorch #ios

wakelock_plus

(★ 108)

Flutter plugin that allows you to keep the device screen awake on Android, iOS, macOS, Windows, Linux, and web.

File Explorer

Download Latest Version (.zip)

- - checks.yml
  - pana.yml
- CONTRIBUTING.md
- PULL_REQUEST_TEMPLATE.md
- - .gitignore
  - build.gradle
  - settings.gradle
- - .gitignore
  - analysis_options.yaml
  - pubspec.yaml
  - README.md
- - .gitignore
  - wakelock_plus.podspec
- - wakelock_plus.dart
- - wakelock_plus.podspec
- - messages.dart
- - wakelock_plus_linux_plugin_test.dart
  - wakelock_plus_test.dart
  - wakelock_plus_web_plugin_test.dart
- .gitignore
- analysis_options.yaml
- CHANGELOG.md
- LICENSE
- pubspec.yaml
- README.md
- - messages.g.dart
  - wakelock_plus_platform_interface.dart
- - messages.g.dart
  - wakelock_plus_platform_interface_test.dart
- .gitignore
- analysis_options.yaml
- CHANGELOG.md
- LICENSE
- pubspec.yaml
- README.md
.gitignore
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/fluttercommunity/wakelock_plus

Downloads the entire project code from GitHub to your computer.

cd wakelock_plus

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd wakelock_plus/android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Wakelock Plus 
[![GitHub stars](https://img.shields.io/github/stars/fluttercommunity/wakelock_plus.svg)](https://github.com/fluttercommunity/wakelock_plus) [![Pub version](https://img.shields.io/pub/v/wakelock_plus.svg)](https://pub.dev/packages/wakelock_plus)

A continuation of the original Flutter [plugin](https://github.com/creativecreatorormaybenot/wakelock) 
that allows you to keep the device screen awake, i.e. prevent the screen
from sleeping.

## Supported platforms

| Platform | `wakelock_plus` support |
|:---------|:------------------:|
| Android  |         ✅          |
| iOS      |         ✅          |
| Web      |         ✅          |
| macOS    |         ✅          |
| Windows  |         ✅          |
| Linux    |         ✅          |

## Getting started

To learn more about the plugin and getting started, you can view the main package's 
[README](https://github.com/fluttercommunity/wakelock_plus/blob/main/wakelock/README.md).

### Plugin structure

This plugin plugin uses the [federated plugins approach](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#federated-plugins).

Android, iOS, macOS (via Hybrid Implementation), and Web use Platform Channels in their implementations. 
Windows and Linux are handled through [Dart-only platform implementations](https://docs.flutter.dev/packages-and-plugins/developing-packages#dart-only-platform-implementations).

The basic API is defined using [`pigeon`](https://pub.dev/packages/pigeon). The pigeon files can be found in the [`pigeons` directory](https://github.com/fluttercommunity/wakelock_plus/tree/main/wakelock/pigeons)
in the main package. The API is defined in Dart in the [`wakelock_plus_platform_interface` package](https://github.com/fluttercommunity/wakelock_plus/tree/main/wakelock_plus_platform_interface).

The packages in this repo are the following:

| Package                                                                                                                            | Implementations                                                                    |
|------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
| [`wakelock_plus`](https://github.com/fluttercommunity/wakelock_plus/tree/main/wakelock_plus)                                       | Main plugin package + Android, iOS, macOS, Windows, Linux, and Web implementations |
| [`wakelock_plus_platform_interface`](https://github.com/fluttercommunity/wakelock_plus/tree/main/wakelock_plus_platform_interface) | Basic API definition & message handling                                            |

## Contributing

If you want to contribute to this plugin, follow the [contributing guide](https://github.com/fluttercommunity/wakelock_plus/blob/main/.github/CONTRIBUTING.md).

## Origin

As stated before, this plugin is a continuation of the original [wakelock](https://pub.dev/packages/wakelock) plugin. 
That plugin was originally based on [`screen`](https://pub.dev/packages/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).

## Migrating from the `wakelock` Plugin

Simply replace the import statement with the one below:

```dart
import 'package:wakelock_plus/wakelock_plus.dart';
```

As well as replacing all the calls to `Wakelock` with `WakelockPlus`:

```dart
WakelockPlus.enable();
//...
WakelockPlus.disable();
//...
WakelockPlus.toggle(enable: true);
```