useWakeLock

Category

Browser

Export Size

727 B

Last Changed

3 years ago

Reactive Screen Wake Lock API. Provides a way to prevent devices from dimming or locking the screen when an application needs to keep running.

Demo

source

Is Supported: true

Is Active: false

Usage

import { useWakeLock } from '@vueuse/core'

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

If request is called, isActive will be true, and if release is called, or other tab is displayed, or the window is minimized,isActive will be false.

Type Declarations

type WakeLockType = "screen"
export interface WakeLockSentinel extends EventTarget {
  type: WakeLockType
  released: boolean
  release: () => Promise<void>
}
export type UseWakeLockOptions = ConfigurableNavigator & ConfigurableDocument
/**
 * Reactive Screen Wake Lock 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

Contributors

Anthony Fu

Jelf

vuff

HannesOberreiter

wheat

koheing

Changelog

No recent changes