useWakeLock

类别

Browser

导出体积

1.04 kB

上次更改

2 months ago

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

示例

源码 playground (beta)

是否支持: false

激活状态: false

用法

import { useWakeLock
 } from '@vueuse/core'

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

当调用 request 时，如果文档可见，将请求唤醒锁。否则，请求将排队，直到文档变为可见。如果请求成功，isActive 将为 true。每当文档被隐藏时，isActive 将为 false。

当调用 release 时，将释放唤醒锁。如果有排队的请求，将被取消。

要立即请求唤醒锁，即使文档被隐藏，请使用 forceRequest。请注意，如果文档被隐藏，可能会引发错误。

类型声明

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
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useWakeLock
(options
?: UseWakeLockOptions
): {
  sentinel
: ShallowRef
<WakeLockSentinel | null, WakeLockSentinel | null>
  isSupported
: ComputedRef
<boolean>
  isActive
: ComputedRef
<boolean>
  request
: (type
: WakeLockType
) => Promise
<void>
  forceRequest
: (type
: WakeLockType
) => Promise
<void>
  release
: () => Promise
<void>
}
export type UseWakeLockReturn
 = ReturnType
<typeof useWakeLock
>