Skip to main content
Version: Next

Taro.getBatteryInfo(option)

Obtains the device's battery level. The synchronous API Taro.getBatteryInfoSync is not available on iOS.

Reference

Type

(option?: Option) => void

Parameters

Option

PropertyTypeRequiredDescription
complete(res: any) => voidNoThe callback function used when the API call completed (always executed whether the call succeeds or fails)
fail(res: any) => voidNoThe callback function for a failed API call
success(res: Result) => voidNoThe callback function for a successful API call

SuccessCallbackResult

PropertyTypeDescription
isChargingbooleanIndicates whether the device is charging.
levelstringThe device's battery level. Range: 1-100.
errMsgstringCall result

API Support

APIWeChat Mini-ProgramH5React Native
Taro.getBatteryInfo✔️