Skip to content

useBattery

Category
Export Size
743 B
Last Changed
15 minutes ago

响应式的 Battery Status API,更常被称为电池 API,提供有关系统电池充电级别的信息,并允许在电池级别或充电状态发生变化时发送事件通知。这可以用来调整您的应用程序的资源使用,以减少电池耗尽时的电池消耗,或在电池耗尽之前保存更改,以防止数据丢失。

Demo

isSupported: false
charging: false
chargingTime: 0
dischargingTime: 0
level: 1

用法

js
import { useBattery } from '@vueuse/core'

const { charging, chargingTime, dischargingTime, level } = useBattery()
状态类型描述
chargingBoolean设备当前是否正在充电。
chargingTimeNumber直到设备完全充满的秒数。
dischargingTimeNumber直到设备完全放电的秒数。
levelNumber介于 0 和 1 之间的数字,表示当前的充电水平。

使用场景

我们的应用程序通常不会关注电池电量,但我们可以对应用程序进行一些调整,使其对电量较低的用户更友好。

  • 触发特殊的“省电模式”暗色主题设置。
  • 停止自动播放新闻动态中的视频。
  • 禁用一些不是必要的后台任务。
  • 限制网络调用并减少 CPU/内存消耗。

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

vue
<template>
  <UseBattery v-slot="{ charging }">
    正在充电: {{ charging }}
  </UseBattery>
</template>

类型声明

typescript
export interface BatteryManager extends EventTarget {
  charging: boolean
  chargingTime: number
  dischargingTime: number
  level: number
}
/**
 * 响应式电池状态
 *
 * @see https://vueuse.org/useBattery
 */
export declare function useBattery(options?: ConfigurableNavigator): {
  isSupported: ComputedRef<boolean>
  charging: Ref<boolean, boolean>
  chargingTime: Ref<number, number>
  dischargingTime: Ref<number, number>
  level: Ref<number, number>
}
export type UseBatteryReturn = ReturnType<typeof useBattery>

Source

SourceDemoDocs

贡献者

Anthony Fu
丶远方
Anthony Fu
Tachibana Shin
vaakian X
Jelf
Piet Althoff
Shinigami
wheat
Alex Kozack
Antério Vieira

变更日志

v10.7.2 on 1/14/2024
30245 - fix: fake signal API support in some utilities (#3634)
v9.11.0 on 1/17/2023
d5321 - fix(components): mark defineComponent as pure (#2623)

Released under the MIT License.