useWakeLock

カテゴリ

ブラウザ

エクスポートサイズ

727 B

最終更新日

先週

リアクティブなScreen Wake Lock API。アプリケーションが実行を継続する必要がある場合に、デバイスの画面の自動消灯やロックを防止する方法を提供します。

デモ

ソース

サポート済み: false

アクティブ: false

使用方法

import { useWakeLock } from '@vueuse/core'

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

requestが呼び出されると、ドキュメントが表示されている場合にウェイクロックが要求されます。表示されていない場合は、ドキュメントが表示されるまで要求がキューに入れられます。要求が成功すると、isActiveはtrueになります。ドキュメントが非表示になると、isActiveはfalseになります。

releaseが呼び出されると、ウェイクロックが解放されます。キューに入れられた要求がある場合は、キャンセルされます。

ドキュメントが非表示であっても、ウェイクロックをすぐに要求するには、forceRequestを使用します。ただし、ドキュメントが非表示の場合は、エラーが発生する可能性があります。

型宣言

typescript

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.dokyumento.jp/useWakeLock
 * @param options
 */
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>