unwrapTarget

Resolves a possibly reactive target into an object that can receive DOM event listeners. It accepts elements, window, document, and Vue component instances.

Component instances are resolved through $el. Empty values return null.

Importing

import { unwrapTarget } from '@almighty-shogun/common';

Usage

import { ref } from 'vue';
import { unwrapTarget } from '@almighty-shogun/common';

const target = ref<HTMLElement | null>(null);
const resolved = unwrapTarget(target);

Parameters

target: MaybeRefOrGetter<NullableOrUndefinable<ComponentTarget>>
Event target, component instance, ref, or getter to resolve.

Returns

The resolved DOM event target or null.

Uses

• HTMLTarget
• Nullable
• NullableOrUndefinable
• isHtmlElement

Type signature

declare function unwrapTarget(
    target: MaybeRefOrGetter<NullableOrUndefinable<ComponentTarget>>
): Nullable<HTMLTarget>;

type ComponentTarget = HTMLTarget | ComponentPublicInstance;