wakelock

Source

<drab-wakelock auto-lock>
    <button data-trigger class="button button-primary">
        <span data-content>Lock</span>
        <template data-swap>Unlock</template>
    </button>
</drab-wakelock>

<!-- Alternatively, set without a `trigger` (hidden) -->
<!-- <drab-wakelock locked auto-lock></drab-wakelock> -->

Overview

WakeLock uses the WakeLock API to ensure the screen does not turn off when viewing the page on supported devices. Use your best judgement for when this is necessary, for example, if you have a timer that needs to stay on, or you are displaying a QR code.

WakeLock can be toggled with a trigger, or will be requested if the element has a locked attribute when connected.
Use content and swap elements to adjust the UI based on the current state.
request and release methods are provided to set the WakeLock with JavaScript.
trigger is disabled if not supported.
WakeLock is released when the element is removed from the DOM.

auto-lock

By default, the WakeLock will be released when the tab is not active. Use the auto-lock attribute to automatically request the WakeLock when the user views the tab again.

Extends

Base

Constructors

new WakeLock()

new WakeLock(): WakeLock

Properties

#listenerController

private #listenerController: AbortController

To clean up event listeners added to document when the element is removed.

Inherited from

Base.#listenerController

Source

src/package/base/index.ts:17

wakeLock

wakeLock: null | WakeLockSentinel = null

Source

src/package/wakelock/index.ts:23

Accessors

#autoLock

get private #autoLock(): boolean

the auto-lock attribute controls whether an active WakeLock should be restored when navigating back to the page.

Returns

boolean

Source

src/package/wakelock/index.ts:37

event

get event(): keyof HTMLElementEventMap

Event for the trigger to execute.

For example, set to "mouseover" to execute the event when the user hovers the mouse over the trigger, instead of when they click it.

Default

"click";

set event(value): void

Parameters

• value: keyof HTMLElementEventMap

Returns

keyof HTMLElementEventMap

Source

src/package/base/index.ts:30

Methods

#wakeLockSupported()

private #wakeLockSupported(): boolean

If the WakeLock API is supported on the user’s device.

Returns

boolean

Source

src/package/wakelock/index.ts:30

connectedCallback()

connectedCallback(): void

Called when custom element is added to the page.

Returns

void

Inherited from

Base.connectedCallback

Source

src/package/base/index.ts:155

destroy()

destroy(): void

Passed into disconnectedCallback, since Base needs to run disconnectedCallback as well. It is overridden in each element that needs to run disconnectedCallback.

Returns

void

Overrides

Base.destroy

Source

src/package/wakelock/index.ts:105

disconnectedCallback()

disconnectedCallback(): void

Called when custom element is removed from the page.

Returns

void

Inherited from

Base.disconnectedCallback

Source

src/package/base/index.ts:167

getContent()

getContent<T>(instance): T

Type parameters

• T extends HTMLElement = HTMLElement

Parameters

• instance= undefined

The instance of the desired element, ex: HTMLDialogElement. Defaults to HTMLElement.

Returns

T

The element that matches the content selector.

Inherited from

Base.getContent

Default

this.querySelector("[data-content]");

Source

src/package/base/index.ts:55

getTrigger()

getTrigger<T>(): NodeListOf<T>

Type parameters

• T extends HTMLElement = HTMLElement

Returns

NodeListOf<T>

All of the elements that match the trigger selector.

Inherited from

Base.getTrigger

Default

this.querySelectorAll("[data-trigger]");

Source

src/package/base/index.ts:42

mount()

mount(): void

Passed into queueMicrotask in connectedCallback. It is overridden in each component that needs to run connectedCallback.

The reason for this is to make these elements work better with frameworks like Svelte. For SSR this isn’t necessary, but when client side rendering, the HTML within the custom element isn’t available before connectedCallback is called. By waiting until the next microtask, the HTML content is available—then for example, listeners can be attached to elements inside.