@learn-hunger/visual-gestures
Version:
VisualGestures.js is a package that empowers users to effortlessly control the cursor, including actions such as hover, click, drag, and drop, through precise finger movements in the air.
108 lines (107 loc) • 4.01 kB
TypeScript
import { IEvents, IGestureCustomProps } from "../../utilities/vg-types";
import { IVgPointerEvents, TEvents } from "../interfaces/vg-events-interface";
import { VgPointerEnter } from "../custom-events/vg-pointer-enter";
import { VgPointerLeave } from "../custom-events/vg-pointer-leave";
import { VgPointerMove } from "../custom-events/vg-pointer-move";
import { VgPointerDown } from "../custom-events/vg-pointer-down";
import { VgPointerUp } from "../custom-events/vg-pointer-up";
import { VgPointerClick } from "../custom-events/vg-pointer-click";
import { VgPointerDrop } from "../custom-events/vg-pointer-drop";
import { VgPointerDrag } from "../custom-events/vg-pointer-drag";
/**
* spefically events are triggered here
* corresponding event callbacks are triggered here
*
*/
export declare abstract class AVgPointerEvents implements IVgPointerEvents {
/**
* common utility to trigger events
* @param element
* @param event
*/
dispatch(element: HTMLElement, event: TEvents): void;
/**
* resetting the event callbacks
*/
dispose(): void;
/**
* When mouse is moved
*
* @type {!VgPointerMove}
*/
vgPointerMove: VgPointerMove;
_onPointerMoveCallback?: IEvents["onPointerMove"];
set onPointerMove(callback: IEvents["onPointerMove"]);
get onPointerMove(): IEvents["onPointerMove"];
triggerMouseMove(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* When mouse is Enter into an element
*
* @type {!VgPointerEnter}
*/
vgPointerEnter: VgPointerEnter;
_onPointerEnterCallback?: IEvents["onPointerEnter"];
set onPointerEnter(callback: IEvents["onPointerEnter"]);
get onPointerEnter(): IEvents["onPointerEnter"];
triggerMouseEnter(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* when mouse is leaved from an element
*
* @type {!VgPointerLeave}
*/
vgPointerLeave: VgPointerLeave;
_onPointerLeaveCallback?: IEvents["onPointerLeave"];
set onPointerLeave(callback: IEvents["onPointerLeave"]);
get onPointerLeave(): IEvents["onPointerLeave"];
triggerMouseLeave(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* when mouse Down
*
* @type {!VgPointerDown}
*/
vgPointerDown: VgPointerDown;
_onPointerDownCallback?: IEvents["onPointerDown"];
set onPointerDown(callback: IEvents["onPointerDown"]);
get onPointerDown(): IEvents["onPointerDown"];
triggerMouseDown(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* when mouse Up
*
* @type {!VgPointerUp}
*/
vgPointerUp: VgPointerUp;
_onPointerUpCallback?: IEvents["onPointerUp"];
set onPointerUp(callback: IEvents["onPointerUp"]);
get onPointerUp(): IEvents["onPointerUp"];
triggerMouseUp(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* when mouse Click
*
* @type {!VgPointerClick}
*/
vgPointerClick: VgPointerClick;
_onPointerClickCallback?: IEvents["onPointerClick"];
set onPointerClick(callback: IEvents["onPointerClick"]);
get onPointerClick(): IEvents["onPointerClick"];
triggerMouseClick(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* when mouse Drop
*
* @type {!VgPointerDrop}
*/
vgPointerDrop: VgPointerDrop;
_onPointerDropCallback?: IEvents["onPointerDrop"];
set onPointerDrop(callback: IEvents["onPointerDrop"]);
get onPointerDrop(): IEvents["onPointerDrop"];
triggerMouseDrop(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
/**
* when mouse Drag
*
* @type {!VgPointerDrag}
*/
vgPointerDrag: VgPointerDrag;
_onPointerDragCallback?: IEvents["onPointerDrag"];
set onPointerDrag(callback: IEvents["onPointerDrag"]);
get onPointerDrag(): IEvents["onPointerDrag"];
triggerMouseDrag(mouseInit: MouseEventInit, props: IGestureCustomProps): void;
}