@exadel/esl/modules/esl-utils/abstract/component.d.ts

Exadel Smart Library (ESL) is the lightweight custom elements library that provide a set of super-flexible components

import type { ExtractEventName, ESLEventListener, ESLListenerTarget, ESLListenerHandler, ESLListenerCriteria, ESLListenerDescriptor } from '../../esl-event-listener/core';
export interface ESLBaseComponent {
    /** Subscribes (or resubscribes) all known descriptors that matches criteria */
    $$on<ETarget extends ESLListenerTarget, EName extends ExtractEventName<ETarget>>(criteria: ESLListenerCriteria<ETarget, EName>): ESLEventListener[];
    /** Subscribes `handler` method marked with `@listen` decorator */
    $$on(handler: ESLListenerHandler): ESLEventListener[];
    /** Subscribes `handler` function by the passed DOM event descriptor {@link ESLListenerDescriptor} or event name */
    $$on<ETarget extends ESLListenerTarget, EName extends ExtractEventName<ETarget>>(event: EName | ESLListenerDescriptor<ETarget, EName>, handler: ESLListenerHandler<EName>): ESLEventListener[];
    /** Unsubscribes event listeners */
    $$off(...condition: ESLListenerCriteria[]): ESLEventListener[];
    /**
     * Dispatches component custom event on current DOM related element.
     * @param eventName - event name
     * @param eventInit - custom event init. See {@link CustomEventInit}
     */
    $$fire(eventName: string, eventInit?: CustomEventInit): boolean;
    /** Finds the first element by the specified ESLTraversingQuery relative to the current DOM-related element. */
    $$find(selector: string): Element | null;
    /** Finds all elements by the specified ESLTraversingQuery relative to the current DOM-related element. */
    $$findAll(selector: string): Element[];
    /**
     * Gets or sets CSS classes for current DOM related element.
     * @param cls - CSS classes query {@link CSSClassUtils}
     * @param value - boolean to set CSS class(es) state or undefined to skip mutation
     * @returns current classes state or passed state
     */
    $$cls(cls: string, value?: boolean): boolean;
    /**
     * Gets or sets an attribute for the current DOM related element.
     * If the `value` param is undefined then skips mutation.
     * @param name - attribute name
     * @param value - string attribute value, boolean attribute state or `null` to delete attribute
     * @returns the current attribute value or previous value for mutation
     */
    $$attr(name: string, value?: null | boolean | string): string | null;
    /** Default error logger for `@safe` decorator */
    $$error(error: Error | string, key: string): void;
}