fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
1.7 KiB
1.7 KiB
category
| category |
|---|
| Browser |
useWakeLock
Reactive Screen Wake Lock API. Provides a way to prevent devices from dimming or locking the screen when an application needs to keep running.
Usage
import { useWakeLock } from '@vueuse/core';
const { isSupported, isActive, forceRequest, request, release } = useWakeLock();
When 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.
When release is called, the wake lock will be released. If there is a queued request, it will be canceled.
To 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.
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
*
* @__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>;