@tempots/dom
Version:
Fully-typed frontend framework alternative to React and Angular
159 lines (158 loc) • 9.11 kB
TypeScript
import { Renderable } from '../types/domain';
/**
* Attaches an event handler to the 'click' event that triggers when a checkbox is checked or unchecked.
* @param fn - The callback function to be executed when the checkbox is clicked.
* @alpha
*/
export declare const OnChecked: (fn: (event: boolean) => void) => Renderable;
/**
* Represents a collection of HTML event handlers that can be attached to an element.
* @public
*/
export declare const on: {
abort: (handler: (event: Event) => void) => Renderable;
animationcancel: (handler: (event: AnimationEvent) => void) => Renderable;
animationend: (handler: (event: AnimationEvent) => void) => Renderable;
animationiteration: (handler: (event: AnimationEvent) => void) => Renderable;
animationstart: (handler: (event: AnimationEvent) => void) => Renderable;
auxclick: (handler: (event: MouseEvent) => void) => Renderable;
blur: (handler: (event: FocusEvent) => void) => Renderable;
cancel: (handler: (event: Event) => void) => Renderable;
canplay: (handler: (event: Event) => void) => Renderable;
canplaythrough: (handler: (event: Event) => void) => Renderable;
change: (handler: (event: Event) => void) => Renderable;
click: (handler: (event: MouseEvent) => void) => Renderable;
close: (handler: (event: Event) => void) => Renderable;
contextmenu: (handler: (event: MouseEvent) => void) => Renderable;
cuechange: (handler: (event: Event) => void) => Renderable;
dblclick: (handler: (event: MouseEvent) => void) => Renderable;
drag: (handler: (event: DragEvent) => void) => Renderable;
dragend: (handler: (event: DragEvent) => void) => Renderable;
dragenter: (handler: (event: DragEvent) => void) => Renderable;
dragexit: (handler: (event: Event) => void) => Renderable;
dragleave: (handler: (event: DragEvent) => void) => Renderable;
dragover: (handler: (event: DragEvent) => void) => Renderable;
dragstart: (handler: (event: DragEvent) => void) => Renderable;
drop: (handler: (event: DragEvent) => void) => Renderable;
durationchange: (handler: (event: Event) => void) => Renderable;
emptied: (handler: (event: Event) => void) => Renderable;
ended: (handler: (event: Event) => void) => Renderable;
error: (handler: (event: ErrorEvent) => void) => Renderable;
focus: (handler: (event: FocusEvent) => void) => Renderable;
focusin: (handler: (event: FocusEvent) => void) => Renderable;
focusout: (handler: (event: FocusEvent) => void) => Renderable;
gotpointercapture: (handler: (event: PointerEvent) => void) => Renderable;
input: (handler: (event: Event) => void) => Renderable;
invalid: (handler: (event: Event) => void) => Renderable;
keydown: (handler: (event: KeyboardEvent) => void) => Renderable;
keypress: (handler: (event: KeyboardEvent) => void) => Renderable;
keyup: (handler: (event: KeyboardEvent) => void) => Renderable;
load: (handler: (event: Event) => void) => Renderable;
loadeddata: (handler: (event: Event) => void) => Renderable;
loadedmetadata: (handler: (event: Event) => void) => Renderable;
loadend: (handler: (event: ProgressEvent<EventTarget>) => void) => Renderable;
loadstart: (handler: (event: ProgressEvent<EventTarget>) => void) => Renderable;
lostpointercapture: (handler: (event: PointerEvent) => void) => Renderable;
mousedown: (handler: (event: MouseEvent) => void) => Renderable;
mouseenter: (handler: (event: MouseEvent) => void) => Renderable;
mouseleave: (handler: (event: MouseEvent) => void) => Renderable;
mousemove: (handler: (event: MouseEvent) => void) => Renderable;
mouseout: (handler: (event: MouseEvent) => void) => Renderable;
mouseover: (handler: (event: MouseEvent) => void) => Renderable;
mouseup: (handler: (event: MouseEvent) => void) => Renderable;
pause: (handler: (event: Event) => void) => Renderable;
play: (handler: (event: Event) => void) => Renderable;
playing: (handler: (event: Event) => void) => Renderable;
pointercancel: (handler: (event: PointerEvent) => void) => Renderable;
pointerdown: (handler: (event: PointerEvent) => void) => Renderable;
pointerenter: (handler: (event: PointerEvent) => void) => Renderable;
pointerleave: (handler: (event: PointerEvent) => void) => Renderable;
pointermove: (handler: (event: PointerEvent) => void) => Renderable;
pointerout: (handler: (event: PointerEvent) => void) => Renderable;
pointerover: (handler: (event: PointerEvent) => void) => Renderable;
pointerup: (handler: (event: PointerEvent) => void) => Renderable;
progress: (handler: (event: ProgressEvent<EventTarget>) => void) => Renderable;
ratechange: (handler: (event: Event) => void) => Renderable;
reset: (handler: (event: Event) => void) => Renderable;
resize: (handler: (event: UIEvent) => void) => Renderable;
scroll: (handler: (event: Event) => void) => Renderable;
securitypolicyviolation: (handler: (event: SecurityPolicyViolationEvent) => void) => Renderable;
seeked: (handler: (event: Event) => void) => Renderable;
seeking: (handler: (event: Event) => void) => Renderable;
select: (handler: (event: Event) => void) => Renderable;
selectionchange: (handler: (event: Event) => void) => Renderable;
selectstart: (handler: (event: Event) => void) => Renderable;
stalled: (handler: (event: Event) => void) => Renderable;
submit: (handler: (event: Event) => void) => Renderable;
suspend: (handler: (event: Event) => void) => Renderable;
timeupdate: (handler: (event: Event) => void) => Renderable;
toggle: (handler: (event: Event) => void) => Renderable;
touchcancel: (handler: (event: TouchEvent) => void) => Renderable;
touchend: (handler: (event: TouchEvent) => void) => Renderable;
touchmove: (handler: (event: TouchEvent) => void) => Renderable;
touchstart: (handler: (event: TouchEvent) => void) => Renderable;
transitioncancel: (handler: (event: TransitionEvent) => void) => Renderable;
transitionend: (handler: (event: TransitionEvent) => void) => Renderable;
transitionrun: (handler: (event: TransitionEvent) => void) => Renderable;
transitionstart: (handler: (event: TransitionEvent) => void) => Renderable;
volumechange: (handler: (event: Event) => void) => Renderable;
waiting: (handler: (event: Event) => void) => Renderable;
};
/**
* Creates an event handler that emits the value of an HTMLInputElement.
*
* @param fn - The callback function that will receive the emitted value.
* @returns An event handler function that can be attached to an event listener.
* @public
*/
export declare const emitValue: (fn: (text: string) => void) => (event: Event) => void;
/**
* Calls the provided function with the value of an HTMLInputElement as a number.
*
* @param fn - The function to be called with the value as a number.
* @returns A function that can be used as an event handler.
* @public
*/
export declare const emitValueAsNumber: (fn: (num: number) => void) => (event: Event) => void;
/**
* Converts the value of an HTML input element to a Date object and emits it using the provided callback function.
* @param fn - The callback function to be called with the converted Date object.
* @returns A function that can be used as an event handler for input events.
* @public
*/
export declare const emitValueAsDate: (fn: (date: Date) => void) => (event: Event) => void;
/**
* Emits the value of an HTMLInputElement as a Date object.
* @param fn - The callback function to be called with the emitted Date object.
* @returns The event handler function.
* @public
*/
export declare const emitValueAsDateTime: (fn: (date: Date) => void) => (event: Event) => void;
/**
* Calls the provided function with the checked value of the event target.
* @param fn - The function to be called with the checked value.
* @returns A function that takes an event and calls the provided function with the checked value of the event target.
* @public
*/
export declare const emitChecked: (fn: (checked: boolean) => void) => (event: Event) => void;
/**
* Wraps a function to prevent the default behavior of an event before invoking it.
* @param fn - The function to be wrapped.
* @returns A new function that prevents the default behavior of the event and then invokes the original function.
* @public
*/
export declare const emitPreventDefault: (fn: () => void) => (event: Event) => void;
/**
* Creates a new event handler that stops event propagation and invokes the provided function.
* @param fn - The function to be invoked when the event is triggered.
* @returns A new event handler function.
* @public
*/
export declare const emitStopPropagation: (fn: () => void) => (event: Event) => void;
/**
* Creates an event handler that stops immediate propagation of the event and invokes the provided function.
* @param fn - The function to be invoked.
* @returns The event handler function.
* @public
*/
export declare const emitStopImmediatePropagation: (fn: () => void) => (event: Event) => void;