@medyll/idae-be/dist/modules/events.d.ts

A modern, lightweight, and extensible DOM manipulation library built with TypeScript. Designed for precise element targeting and manipulation using a callback-based approach. Features include advanced DOM traversal, event handling, style management, attri

import { Be } from '../be.js';
import type { CommonHandler, HandlerCallBack, HandlerCallBackFn } from '../types.js';
declare enum eventsMethods {
    on = "on",
    off = "off",
    fire = "fire"
}
export type EventHandlerMethods = 'on' | 'off';
export type EventHandlerMethodsProps = {
    [key in EventHandlerMethods]: (eventName?: string) => CustomEvent | EventListener | null;
};
export interface EventHandlerHandle {
    on?: {
        [eventName: string]: CustomEvent | EventListener;
    } & HandlerCallBack;
    off?: {
        [eventName: string]: CustomEvent | EventListener;
    } & HandlerCallBack;
    fire?: {
        event: string;
        detail?: unknown;
        options?: EventInit;
    } & HandlerCallBack;
}
/**
 * Handles event operations for Be elements.
 */
export declare class EventsHandler implements CommonHandler<EventsHandler, EventHandlerHandle> {
    private beElement;
    static methods: eventsMethods[];
    constructor(beElement: Be);
    methods: eventsMethods[];
    /**
     * Handle event actions (add or remove event listeners).
     * @param actions An object specifying the event actions to perform.
     * @returns The Be instance for method chaining.
     */
    handle(actions: EventHandlerHandle): Be;
    /**
     * Adds an event listener to the element(s).
     * @param eventName - The name of the event to listen for.
     * @param handler - The event handler function.
     * @param options - Optional event listener options.
     * @param callback - Optional callback function to execute after adding the event listener.
     * @returns The Be instance for method chaining.
     * @example
     * // HTML: <div id="test"></div>
     * const beInstance = be('#test');
     * beInstance.on('click', () => console.log('Clicked!')); // Adds a click event listener
     */
    on(eventName: string, handler: EventListener, options?: boolean | AddEventListenerOptions, callback?: HandlerCallBackFn): Be;
    /**
     * Removes an event listener from the element(s).
     * @param eventName - The name of the event to remove.
     * @param handler - The event handler function.
     * @param options - Optional event listener options.
     * @param callback - Optional callback function to execute after removing the event listener.
     * @returns The Be instance for method chaining.
     * @example
     * // HTML: <div id="test"></div>
     * const beInstance = be('#test');
     * const handler = () => console.log('Clicked!');
     * beInstance.on('click', handler); // Adds a click event listener
     * beInstance.off('click', handler); // Removes the click event listener
     */
    off(eventName: string, handler: EventListener, options?: boolean | AddEventListenerOptions, callback?: HandlerCallBackFn): Be;
    /**
     * Dispatches a custom event on the element(s).
     * @param eventName - The name of the custom event to dispatch.
     * @param detail - Optional data to include in the event.
     * @param options - Optional event initialization options.
     * @param callback - Optional callback function to execute after dispatching the event.
     * @returns The Be instance for method chaining.
     * @example
     * // HTML: <div id="test"></div>
     * const beInstance = be('#test');
     * beInstance.fire('customEvent', { key: 'value' }); // Dispatches a custom event with data
     */
    fire(eventName: string, detail: unknown, options?: EventInit, callback?: HandlerCallBackFn): Be;
    valueOf(): Be;
}
export {};