@interactjs / core/types

Module: core/types

Table of contents

Interfaces

• ActionMap
• ActionMethod
• ActionProps
• Actions
• CoordsSet
• CoordsSetMember
• EdgeOptions
• HasGetRect
• InertiaOption
• ListenerMap
• OptionMethod
• Point
• PointerEventsOptions
• Rect
• Size

Type Aliases

• ActionChecker
• ActionName
• ArrayElementType
• Context
• CursorChecker
• Dimensions
• Element
• EventTarget
• EventTypes
• FullRect
• InertiaOptions
• Listener
• Listeners
• ListenersArg
• NativePointerEventType
• OrBoolean
• OriginFunction
• PointerEventType
• PointerType
• RectChecker
• RectFunction
• RectResolvable
• Target

Type Aliases

ActionChecker

Ƭ ActionChecker: (pointerEvent: any, defaultAction: string, interactable: Interactable, element: Element, interaction: Interaction) => ActionProps

Type declaration

▸ (pointerEvent, defaultAction, interactable, element, interaction): ActionProps

Parameters

Returns

ActionProps

Defined in

core/types.ts:113

ActionName

Ƭ ActionName: keyof ActionMap

Defined in

core/types.ts:64

ArrayElementType

Ƭ ArrayElementType<T>: T extends infer P[] ? P : never

Type parameters

Defined in

core/types.ts:145

Context

Ƭ Context: Document | Element

Defined in

core/types.ts:12

CursorChecker

Ƭ CursorChecker: (action: ActionProps<ActionName>, interactable: Interactable, element: Element, interacting: boolean) => string

Type declaration

▸ (action, interactable, element, interacting): string

Parameters

Returns

string

Defined in

core/types.ts:95

Dimensions

Ƭ Dimensions: Point & Size

Defined in

core/types.ts:41

Element

Ƭ Element: HTMLElement | SVGElement

Defined in

core/types.ts:11

EventTarget

Ƭ EventTarget: Window | Document | Element

Defined in

core/types.ts:13

EventTypes

Ƭ EventTypes: string | ListenerMap | (string | ListenerMap)[]

Defined in

core/types.ts:136

FullRect

Ƭ FullRect: Required<Rect>

Defined in

core/types.ts:35

InertiaOptions

Ƭ InertiaOptions: InertiaOption | boolean

Defined in

core/types.ts:86

Listener

Ƭ Listener: (…args: any[]) => any

Type declaration

▸ (...args): any

Parameters

Returns

any

Defined in

core/types.ts:138

Listeners

Ƭ Listeners: ListenerMap | ListenerMap[]

Defined in

core/types.ts:139

ListenersArg

Ƭ ListenersArg: Listener | ListenerMap | (Listener | ListenerMap)[]

Defined in

core/types.ts:140

NativePointerEventType

Ƭ NativePointerEventType: typeof NativePointerEvent_

Defined in

core/types.ts:132

OrBoolean

Ƭ OrBoolean<T>: { [P in keyof T]: T[P] | boolean }

Type parameters

Defined in

core/types.ts:7

OriginFunction

Ƭ OriginFunction: (target: Element) => Rect

Type declaration

▸ (target): Rect

Parameters

Returns

Rect

Defined in

core/types.ts:121

PointerEventType

Ƭ PointerEventType: MouseEvent | TouchEvent | Partial<NativePointerEventType> | InteractEvent

Defined in

core/types.ts:133

PointerType

Ƭ PointerType: MouseEvent | Touch | Partial<NativePointerEventType> | InteractEvent

Defined in

core/types.ts:134

RectChecker

Ƭ RectChecker: (element: Element) => Rect

Type declaration

▸ (element): Rect

Parameters

Returns

Rect

Defined in

core/types.ts:130

RectFunction

Ƭ RectFunction<T>: (…args: T) => Rect | Element

Type parameters

Type declaration

▸ (...args): Rect | Element

Parameters

Returns

Rect | Element

Defined in

core/types.ts:37

RectResolvable

Ƭ RectResolvable<T>: Rect | string | Element | RectFunction<T>

Type parameters

Defined in

core/types.ts:39

Target

Ƭ Target: EventTarget | string

Defined in

core/types.ts:14