https://github.com/apache/cordova-plugin-battery-status
Apache Cordova Battery Status Plugin
https://github.com/apache/cordova-plugin-battery-status
android cordova hacktoberfest ios java javascript library mobile nodejs objective-c
Last synced: 7 months ago
JSON representation
Apache Cordova Battery Status Plugin
- Host: GitHub
- URL: https://github.com/apache/cordova-plugin-battery-status
- Owner: apache
- License: apache-2.0
- Created: 2013-06-22T07:00:13.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T03:21:04.000Z (about 1 year ago)
- Last Synced: 2025-04-10T11:58:42.623Z (7 months ago)
- Topics: android, cordova, hacktoberfest, ios, java, javascript, library, mobile, nodejs, objective-c
- Language: JavaScript
- Homepage: https://cordova.apache.org/
- Size: 351 KB
- Stars: 101
- Watchers: 26
- Forks: 147
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cordova-plugins - Battery Status
- awesome-cordova-plugins - Battery Status
README
---
title: Battery Status
description: Get events for device battery level.
---
# cordova-plugin-battery-status
[](https://github.com/apache/cordova-plugin-battery-status/actions/workflows/android.yml) [](https://github.com/apache/cordova-plugin-battery-status/actions/workflows/chrome.yml) [](https://github.com/apache/cordova-plugin-battery-status/actions/workflows/ios.yml) [](https://github.com/apache/cordova-plugin-battery-status/actions/workflows/lint.yml)
This plugin provides an implementation of an old version of the [Battery Status Events API][w3c_spec]. It adds the following three events to the `window` object:
* batterystatus
* batterycritical
* batterylow
Applications may use `window.addEventListener` to attach an event listener for any of the above events after the `deviceready` event fires.
## Installation
cordova plugin add cordova-plugin-battery-status
## Status object
All events in this plugin return an object with the following properties:
- __level__: The battery charge percentage (0-100). _(Number)_
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
## batterystatus event
Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an [object][status_object] containing battery status.
### Example
window.addEventListener("batterystatus", onBatteryStatus, false);
function onBatteryStatus(status) {
console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
}
### Supported Platforms
- iOS
- Android
- Browser (Chrome, Firefox, Opera)
### Quirks: Android
**Warning**: the Android implementation is greedy and prolonged use will drain the device's battery.
## batterylow event
Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
### Example
window.addEventListener("batterylow", onBatteryLow, false);
function onBatteryLow(status) {
alert("Battery Level Low " + status.level + "%");
}
### Supported Platforms
- iOS
- Android
- Browser (Chrome, Firefox, Opera)
## batterycritical event
Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
### Example
window.addEventListener("batterycritical", onBatteryCritical, false);
function onBatteryCritical(status) {
alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
}
### Supported Platforms
- iOS
- Android
- Browser (Chrome, Firefox, Opera)
[w3c_spec]: https://www.w3.org/TR/battery-status/
[status_object]: #status-object