Interface EnhancerContext<Options>

The toolkit handed to an enhancer's setup. Everything registered through on/observe/add is torn down automatically when the instance is destroyed.

interface EnhancerContext<Options extends object> {
    add: (disposer: Disposer) => void;
    container: HTMLElement | Document;
    emit: (type: string, detail?: unknown, options?: EmitOptions) => boolean;
    observe: (
        target: Node,
        callback: (records: MutationRecord[]) => void,
        init?: MutationObserverInit,
    ) => void;
    on: <E extends Event = Event>(
        target: EventTarget,
        type: string,
        handler: (event: E) => void,
        options?: boolean | AddEventListenerOptions,
    ) => void;
    options: Options;
    root: HTMLElement;
    uid: (prefix?: string) => string;
}

Type Parameters

  • Options extends object

Properties

add container emit observe on options root uid

Properties

add

add: (disposer: Disposer) => void

Register an arbitrary disposer to run on teardown.

container

container: HTMLElement | Document

The container the enhancer was invoked with (often document).

emit

emit: (type: string, detail?: unknown, options?: EmitOptions) => boolean

Dispatch a bubbling hl:* CustomEvent from the root. Returns false when a cancelable event was prevented.

observe

observe: (
    target: Node,
    callback: (records: MutationRecord[]) => void,
    init?: MutationObserverInit,
) => void

Watch target with a MutationObserver that is disconnected on destroy. Defaults to { childList: true, subtree: true }, which is what enhancers need to pick up items added or removed after they ran. No-op where MutationObserver is unavailable.

on

on: <E extends Event = Event>(
    target: EventTarget,
    type: string,
    handler: (event: E) => void,
    options?: boolean | AddEventListenerOptions,
) => void

Attach an event listener that is auto-removed on destroy.

options

options: Options

Options merged from the definition's defaults, the root's data-hl-* attributes, and the caller.

root

root: HTMLElement

The matched component root.

uid

uid: (prefix?: string) => string

Generate a unique id namespaced to this enhancer.

Settings

Member Visibility

On This Page

Properties