@forest-js/core
Version:
A tiny, functional DOM engine with explicit update and real DOM.
32 lines • 1.28 kB
TypeScript
import { StoreMap, Triggers, Utility, UtilityProps } from "../types";
/**
* @function addTrigger
* @description Utility for adding triggers to an element
* @template R Trigger object to add
* @template S StoreMap type when used reactively
* @template E Element type (defaults to HTMLElement)
* @param args - Trigger object or store and mapper function
* @returns Utility function for adding triggers
* @example
* ```ts
* addTrigger({ customTrigger: () => console.log("Custom trigger") })(MyElement);
* const triggers = getTriggers(MyElement);
* triggers.customTrigger();
* ```
*/
export declare const addTrigger: <R extends Triggers, S extends StoreMap = StoreMap, E extends HTMLElement = HTMLElement>(...args: UtilityProps<R, S>) => Utility<E>;
/**
* @function getTrigger
* @description Utility for getting triggers from an element for use outside of component
* @template T Trigger object type
* @template E Element type (defaults to HTMLElement)
* @param el - Element to get triggers from
* @returns Trigger object
* @example
* ```ts
* const triggers = getTriggers(MyElement);
* triggers.customTrigger();
* ```
*/
export declare const getTrigger: <T extends Triggers, E extends HTMLElement>(el: E) => Readonly<T>;
//# sourceMappingURL=trigger.d.ts.map