Function $

$<T extends HTMLElement = HTMLElement>(
selector: string | T | T[],
opts?: SelectOptions,
): DomCollection<T>

Query the DOM and return a DomCollection wrapping matched elements.

Type Parameters

T extends HTMLElement = HTMLElement

Parameters

selector: string | T | T[]
Optionalopts: SelectOptions

Returns DomCollection<T>

Example

const buttons = $<HTMLButtonElement>('.btn');
    const scoped = $('.item', { container: sidebar });
    const managed = $('.chat', { signal: controller.signal });
    const both = $('.btn', { container: sidebar, signal: ctrl.signal });
    const wrapped = $(element);
    const wrapped = $([el1, el2], { signal: ctrl.signal });

Index

Properties

create template

Properties

create

create: <K extends keyof HTMLElementTagNameMap>(
tag: K,
opts?: CreateOptions,
) => DomCollection<HTMLElementTagNameMap[K]>

Create a DOM element and return it wrapped in a DomCollection.

Example

const card = $.create('div', { text: 'Hello', class: ['card'] });

template

template: (
source: string | HTMLTemplateElement,
config?: TemplateConfig,
) => TemplateStamper

Create a reusable TemplateStamper for an HTML <template> element.

Example

const card = $.template('#user-card', {
        map: { '.name': { css: { fontWeight: 'bold' } } }
    });
    card.stamp({ '.name': 'Alice' }).into(container);

Function $

Type Parameters

Parameters

Returns DomCollection<T>

Example

Index

Properties

Properties

create

Example

template

Example

Settings

On This Page