Class DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>

Dragger that detects swipe direction

Type Parameters

StaticProps extends NDraggerDirection.IStaticProps = NDraggerDirection.IStaticProps
ChangeableProps extends NDraggerDirection.IChangeableProps = NDraggerDirection.IChangeableProps
CallbacksTypes extends NDraggerDirection.ICallbacksTypes = NDraggerDirection.ICallbacksTypes

Hierarchy

DraggerBase<StaticProps, ChangeableProps, CallbacksTypes>
- DraggerDirection

Constructors

constructor

new DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?, canInit?): DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NDraggerDirection.IStaticProps = NDraggerDirection.IStaticProps
- ChangeableProps extends NDraggerDirection.IChangeableProps = NDraggerDirection.IChangeableProps
- CallbacksTypes extends NDraggerDirection.ICallbacksTypes = NDraggerDirection.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
- canInit: boolean = true
Returns DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>
Inherited from DraggerBase<StaticProps, ChangeableProps, CallbacksTypes>.constructor
- Defined in src/components/DraggerBase/index.ts:105

Properties

`Protected` _container

_container: Window | Element

Preloader container

`Protected` _coords

_coords: IVector2

Current coordinates

`Protected` `Optional` _handleEndTimeout

_handleEndTimeout?: Timeout

Timeout of handleEnd

`Protected` _pointerID

_pointerID: null | number

Current pointer id

`Protected` _prevCoords

_prevCoords: IVector2

Last coordinates

`Protected` _runtimeListeners

_runtimeListeners: IAddEventListener[]

Runtime events

`Protected` _startCoords

_startCoords: IVector2

Coordinates on drag start

`Protected` `Optional` _type

_type?: "mouse" | "touch"

Current event type

Accessors

app

get app(): Application
Vevet Application

Returns Application
Inherited from DraggerBase.app
- Defined in src/base/Module/index.ts:68

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

Returns Callbacks<CallbacksTypes>
Inherited from DraggerBase.callbacks
- Defined in src/base/Module/index.ts:47

container

get container(): Window | Element
Preloader container

Returns Window | Element
Inherited from DraggerBase.container
- Defined in src/components/DraggerBase/index.ts:40

coords

get coords(): IVector2
Current coordinates

Returns IVector2
Inherited from DraggerBase.coords
- Defined in src/components/DraggerBase/index.ts:64
set coords(value): void
Current coordinates
Parameters
- value: IVector2
Returns void
Inherited from DraggerBase.coords
- Defined in src/components/DraggerBase/index.ts:69

isDestroyed

get isDestroyed(): boolean
The module is destroyed

Returns boolean
Inherited from DraggerBase.isDestroyed
- Defined in src/base/Module/index.ts:94

isDragging

get isDragging(): boolean
Dragging at the moment

Returns boolean
Inherited from DraggerBase.isDragging
- Defined in src/components/DraggerBase/index.ts:48

isInitialized

get isInitialized(): boolean
The module is initialized

Returns boolean
Inherited from DraggerBase.isInitialized
- Defined in src/base/Module/index.ts:86

name

get name(): string
Module name

Returns string
Inherited from DraggerBase.name
- Defined in src/base/Module/index.ts:73

`Protected` pointerID

get pointerID(): null | number
Current pointer id

Returns null | number
Inherited from DraggerBase.pointerID
- Defined in src/components/DraggerBase/index.ts:56

prefix

get prefix(): string
Returns string
Inherited from DraggerBase.prefix
- Defined in src/components/DraggerBase/index.ts:32

prevCoords

get prevCoords(): IVector2
Last coordinates

Returns IVector2
Inherited from DraggerBase.prevCoords
- Defined in src/components/DraggerBase/index.ts:77
set prevCoords(value): void
Last coordinates
Parameters
- value: IVector2
Returns void
Inherited from DraggerBase.prevCoords
- Defined in src/components/DraggerBase/index.ts:82

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
Current properties

Returns TRequiredModuleProp<StaticProps & ChangeableProps>
Inherited from DraggerBase.props
- Defined in src/base/Module/index.ts:34

startCoords

get startCoords(): IVector2
Coordinates on drag start

Returns IVector2
Inherited from DraggerBase.startCoords
- Defined in src/components/DraggerBase/index.ts:90

type

get type(): undefined | "mouse" | "touch"
Current event type

Returns undefined | "mouse" | "touch"
Inherited from DraggerBase.type
- Defined in src/components/DraggerBase/index.ts:101

Methods

`Protected` _addRuntimeEvents

_addRuntimeEvents(): void
Add runtime events

Returns void
Inherited from DraggerBase._addRuntimeEvents
- Defined in src/components/DraggerBase/index.ts:149

`Protected` _destroy

_destroy(): void
Destroy the module

Returns void
Inherited from DraggerBase._destroy
- Defined in src/components/DraggerBase/index.ts:279

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    container: string;
    isEnabled: boolean;
    isPassive: boolean;
    minLength: number;
}
Returns DeepRequired<StaticProps & ChangeableProps> & {
    container: string;
    isEnabled: boolean;
    isPassive: boolean;
    minLength: number;
}
Overrides DraggerBase._getDefaultProps
- Defined in src/components/DraggerDirection/index.ts:17

`Protected` _getEventCoords

_getEventCoords(event): {
    pointerId: number;
    x: number;
    y: number;
} | {
    pointerId: null;
    x: number;
    y: number;
}
Get normalized event coordinates
Parameters
- event: TEvent
Returns {
    pointerId: number;
    x: number;
    y: number;
} | {
    pointerId: null;
    x: number;
    y: number;
}
Inherited from DraggerBase._getEventCoords
- Defined in src/components/DraggerBase/index.ts:185

`Protected` _handleEnd

_handleEnd(event): void
Event on drag end
Parameters
- event: TEvent
Returns void
Overrides DraggerBase._handleEnd
- Defined in src/components/DraggerDirection/index.ts:25

`Protected` _handleStart

_handleStart(event): boolean
Event on drag start
Parameters
- event: TEvent
Returns boolean
Inherited from DraggerBase._handleStart
- Defined in src/components/DraggerBase/index.ts:207

`Protected` _init

_init(): void
Returns void
Inherited from DraggerBase._init
- Defined in src/components/DraggerBase/index.ts:125

`Protected` _onPropsMutate

_onPropsMutate(): void
This method is called on properties change

Returns void
Inherited from DraggerBase._onPropsMutate
- Defined in src/base/Module/index.ts:197

`Protected` _removeRuntimeEvents

_removeRuntimeEvents(): void
Remove runtime events

Returns void
Inherited from DraggerBase._removeRuntimeEvents
- Defined in src/components/DraggerBase/index.ts:178

`Protected` _setEvents

_setEvents(): void
Set dragger events

Returns void
Inherited from DraggerBase._setEvents
- Defined in src/components/DraggerBase/index.ts:132

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Add a module callback
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
- action: TAction<CallbacksTypes[T]>
- settings: ISettings = {}
Returns IAddedCallback
Inherited from DraggerBase.addCallback
- Defined in src/base/Module/index.ts:245

`Protected` addDestroyableAction

addDestroyableAction(action): void
Add destroyable actions
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from DraggerBase.addDestroyableAction
- Defined in src/base/Module/index.ts:224

addEventListener

addEventListener<El, Target, Callback>(el, target, callback, options?): IAddEventListener
Add a DOM event listener
Type Parameters
- El extends ListenerElement
- Target extends keyof HTMLElementEventMap
- Callback extends ((evt) => void)
Parameters
- el: El
- target: Target
- callback: Callback
- Optional options: IAddEventListenerOptions
Returns IAddEventListener
Inherited from DraggerBase.addEventListener
- Defined in src/base/Module/index.ts:254

addPlugin

addPlugin<T>(plugin): void
Add a single plugin
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
Returns void
Inherited from DraggerBase.addPlugin
- Defined in src/base/Component/index.ts:21

addResponsiveProps

addResponsiveProps(rules): void
Add responsive rules
Parameters
- rules: IResponsive<ChangeableProps>
Returns void
Inherited from DraggerBase.addResponsiveProps
- Defined in src/base/Module/index.ts:173

addViewportCallback

addViewportCallback(target, action, data?): void
Add a viewport callback that will be removed on class destroy
Parameters
- target: keyof NViewport.ICallbacksTypes
- action: ((arg) => void)
  - - (arg): void
    - Parameters
      
      arg: IChanges
      
      Returns void
- data: undefined | ISettings = {}
Returns void
Inherited from DraggerBase.addViewportCallback
- Defined in src/base/Module/index.ts:231

cancel

cancel(): void
Cancel dragging

Returns void
Inherited from DraggerBase.cancel
- Defined in src/components/DraggerBase/index.ts:272

changeProps

changeProps(props): void
Change module properties
Parameters
- props: Partial<ChangeableProps>
Returns void
Inherited from DraggerBase.changeProps
- Defined in src/base/Module/index.ts:184

`Protected` className

className(...classNames): string
Parameters
- Rest ...classNames: string[]
Returns string
Inherited from DraggerBase.className
- Defined in src/base/Module/index.ts:279

destroy

destroy(): void
Destroy the module

Returns void
Inherited from DraggerBase.destroy
- Defined in src/base/Module/index.ts:299

`Protected` handleEnd

handleEnd(event): void
Event on drag end
Parameters
- event: TEvent
Returns void
Inherited from DraggerBase.handleEnd
- Defined in src/components/DraggerBase/index.ts:247

init

init(): void
Initializes the class

Returns void
Inherited from DraggerBase.init
- Defined in src/base/Module/index.ts:202

`Protected` toggleClassName

toggleClassName(element, className, isActive): void
Toggle classList
Parameters
- element: Element
- className: string
- isActive: boolean
Returns void
Inherited from DraggerBase.toggleClassName
- Defined in src/base/Module/index.ts:284

Class DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NDraggerDirection.IStaticProps = NDraggerDirection.IStaticProps

ChangeableProps extends NDraggerDirection.IChangeableProps = NDraggerDirection.IChangeableProps

CallbacksTypes extends NDraggerDirection.ICallbacksTypes = NDraggerDirection.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NDraggerDirection.IStaticProps = NDraggerDirection.IStaticProps

ChangeableProps extends NDraggerDirection.IChangeableProps = NDraggerDirection.IChangeableProps

CallbacksTypes extends NDraggerDirection.ICallbacksTypes = NDraggerDirection.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected _container

Protected _coords

Protected Optional _handleEndTimeout

Protected _pointerID

Protected _prevCoords

Protected _runtimeListeners

Protected _startCoords

Protected Optional _type

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

container

Returns Window | Element

coords

Returns IVector2

Parameters

value: IVector2

Returns void

isDestroyed

Returns boolean

isDragging

Returns boolean

isInitialized

Returns boolean

name

Returns string

Protected pointerID

Returns null | number

prefix

Returns string

prevCoords

Returns IVector2

Parameters

value: IVector2

Returns void

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

startCoords

Returns IVector2

type

Returns undefined | "mouse" | "touch"

Methods

Protected _addRuntimeEvents

Returns void

Protected _destroy

Returns void

Protected _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & { container: string; isEnabled: boolean; isPassive: boolean; minLength: number; }

Protected _getEventCoords

Parameters

event: TEvent

Returns { pointerId: number; x: number; y: number; } | { pointerId: null; x: number; y: number; }

Protected _handleEnd

Parameters

event: TEvent

Returns void

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` _container

`Protected` _coords

`Protected` `Optional` _handleEndTimeout

`Protected` _pointerID

`Protected` _prevCoords

`Protected` _runtimeListeners

`Protected` _startCoords

`Protected` `Optional` _type

`Protected` pointerID

`Protected` _addRuntimeEvents

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
container: string;
isEnabled: boolean;
isPassive: boolean;
minLength: number;
}

`Protected` _getEventCoords

Returns {
pointerId: number;
x: number;
y: number;
} | {
pointerId: null;
x: number;
y: number;
}

`Protected` _handleEnd

`Protected` _handleStart

`Protected` _init

`Protected` _onPropsMutate

`Protected` _removeRuntimeEvents

`Protected` _setEvents

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]

`Protected` handleEnd