1---
2category: Browser
3---
4 
5# useWakeLock
6 
7Reactive [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API). Provides a way to prevent devices from dimming or locking the screen when an application needs to keep running.
8 
9## Usage
10 
11```ts
12import { useWakeLock } from '@vueuse/core'
13 
14const { isSupported, isActive, forceRequest, request, release } = useWakeLock()
15```
16 
17When `request` is called, the wake lock will be requested if the document is visible. Otherwise, the request will be queued until the document becomes visible. If the request is successful, `isActive` will be **true**. Whenever the document is hidden, the `isActive` will be **false**.
18 
19When `release` is called, the wake lock will be released. If there is a queued request, it will be canceled.
20 
21To request a wake lock immediately, even if the document is hidden, use `forceRequest`. Note that this may throw an error if the document is hidden.
22 
23## Type Declarations
24 
25```ts
26type WakeLockType = "screen"
27export interface WakeLockSentinel extends EventTarget {
28  type: WakeLockType
29  released: boolean
30  release: () => Promise<void>
31}
32export type UseWakeLockOptions = ConfigurableNavigator & ConfigurableDocument
33export interface UseWakeLockReturn extends Supportable {
34  sentinel: ShallowRef<WakeLockSentinel | null>
35  isActive: ComputedRef<boolean>
36  request: (type: WakeLockType) => Promise<void>
37  forceRequest: (type: WakeLockType) => Promise<void>
38  release: () => Promise<void>
39}
40/**
41 * Reactive Screen Wake Lock API.
42 *
43 * @see https://vueuse.org/useWakeLock
44 * @param options
45 *
46 * @__NO_SIDE_EFFECTS__
47 */
48export declare function useWakeLock(
49  options?: UseWakeLockOptions,
50): UseWakeLockReturn
51```
52