useWakeLock

Category

Browser

Export Size

727 B

Last Changed

last year

响应式 屏幕唤醒锁定 API。提供了一种防止设备在应用程序需要持续运行时变暗或锁定屏幕的方法。

Demo

source

是否支持: true

激活状态: false

用法

import { useWakeLock } from '@vueuse/core'

const { isSupported, isActive, request, release } = useWakeLock()

如果调用了 request，isActive 将为 true，如果调用了 release，或者其他选项卡被显示，或者窗口被最小化，isActive 将为 false。

类型声明

type WakeLockType = "screen"
export interface WakeLockSentinel extends EventTarget {
  type: WakeLockType
  released: boolean
  release: () => Promise<void>
}
export type UseWakeLockOptions = ConfigurableNavigator & ConfigurableDocument
/**
 * 响应式屏幕唤醒锁定 API。
 *
 * @see https://vueuse.org/useWakeLock
 * @param options
 */
export declare function useWakeLock(options?: UseWakeLockOptions): {
  isSupported: ComputedRef<boolean>
  isActive: Ref<boolean>
  request: (type: WakeLockType) => Promise<void>
  release: () => Promise<void>
}
export type UseWakeLockReturn = ReturnType<typeof useWakeLock>

Source

Source • Demo • Docs

贡献者

Anthony Fu

丶远方

Jelf

vuff

HannesOberreiter

wheat

koheing

变更日志

No recent changes