useWakeLock

v0.0.15testeddemo

Reactive wrapper over the Screen Wake Lock API to keep the screen awake. Re-acquires a deferred lock automatically when the document returns to visible.

Source Tests

Examples

const { isSupported, isActive, request, release } = useWakeLock();
await request('screen');
// ...later
await release();

// forceRequest re-acquires immediately, dropping any existing lock
const { forceRequest } = useWakeLock();
await forceRequest('screen');

Demo

Loading demo…

Signature

export function useWakeLock(options: UseWakeLockOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`options`?	`any`	`{}`	Options (custom `navigator`, `document`)

Returns

UseWakeLockReturn`{ isSupported, sentinel, isActive, request, forceRequest, release }`