Android 4.4	Android 5.1	iOS 9.3	iOS 10.0	Windows 10 Store	Travis CI

This plugin provides an implementation of an old version of the Battery Status Events API. 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.

cordova plugin add cordova-plugin-battery-status

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)

Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an object containing battery status.

window.addEventListener("batterystatus", onBatteryStatus, false);

function onBatteryStatus(status) {
    console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
}

• Amazon Fire OS
• iOS
• Android
• BlackBerry 10
• Windows Phone 7 and 8
• Windows (Windows Phone 8.1 and Windows 10)
• Firefox OS
• Browser (Chrome, Firefox, Opera)

Warning: the Android and Fire OS implementations are greedy and prolonged use will drain the device's battery.

The level property is not supported on Windows Phone 7 because the OS does not provide native APIs to determine battery level. The isPlugged parameter is supported.

The isPlugged parameter is not supported on Windows Phone 8.1. The level parameter is supported.

Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an object containing battery status.

window.addEventListener("batterylow", onBatteryLow, false);

function onBatteryLow(status) {
    alert("Battery Level Low " + status.level + "%");
}

• Amazon Fire OS
• iOS
• Android
• BlackBerry 10
• Firefox OS
• Windows (Windows Phone 8.1 and Windows 10)
• Browser (Chrome, Firefox, Opera)

The batterylow event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.

Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an object containing battery status.

window.addEventListener("batterycritical", onBatteryCritical, false);

function onBatteryCritical(status) {
    alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
}

• Amazon Fire OS
• iOS
• Android
• BlackBerry 10
• Firefox OS
• Windows (Windows Phone 8.1 and Windows 10)
• Browser (Chrome, Firefox, Opera)

The batterycritical event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.