useWakeLock
Controls the Wake Lock API state.
Usage
import { useWakeLock } from "@siberiacancode/reactuse";
const wake = useWakeLock();Example
import { useWakeLock } from "@siberiacancode/reactuse";
export const WakeLockToggle = () => {
const wake = useWakeLock();
return (
<button onClick={() => (wake.active ? wake.release() : wake.request())}>
{wake.active ? "Release" : "Keep awake"}
</button>
);
};immediately:
const wake = useWakeLock({ immediately: true });type:
const wake = useWakeLock({ type: "screen" });Notes
- Hook uses the WakeLock API.
Type Declarations
export interface UseWakeLockOptions {
immediately?: boolean;
type?: WakeLockType;
}
export interface UseWakeLockReturn {
active: boolean;
supported: boolean;
release: () => Promise<void>;
request: () => Promise<void>;
}
export declare const useWakeLock: (
options?: UseWakeLockOptions
) => UseWakeLockReturn;