Class DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>

A draggable component that detects the swipe direction (up, down, left, or right) based on the drag event. Extends the base dragger functionality to determine the direction of the drag after it ends.

Hierarchy

DraggerBase<StaticProps, ChangeableProps, CallbacksTypes>
- DraggerDirection

Index

Constructors

constructor

Accessors

callbacks container coords isDestroyed isDragging isInitialized name prefix prevCoords props startCoords type

Methods

addCallback addEventListener addPlugin addResponsiveProps addViewportCallback cancel changeProps destroy init

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.constructor
- Defined in src/components/DraggerBase/index.ts:145

Accessors

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Retrieves the module's registered callbacks.

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

container

get container(): Element | Window
Returns the dragger's container element or window.

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

coords

get coords(): NDraggerBase.IVector2
Returns the current pointer coordinates.

Returns NDraggerBase.IVector2
Inherited from DraggerBase.coords
- Defined in src/components/DraggerBase/index.ts:81
set coords(value): void
Sets the current pointer coordinates.
Parameters
- value: NDraggerBase.IVector2
Returns void
Inherited from DraggerBase.coords
- Defined in src/components/DraggerBase/index.ts:88

isDestroyed

get isDestroyed(): boolean
Checks if the module has been destroyed.

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

isDragging

get isDragging(): boolean
Indicates whether dragging is currently happening.

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

isInitialized

get isInitialized(): boolean
Checks if the module has been initialized.

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

name

get name(): string
The name of the module, derived from the class name

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

prefix

get prefix(): string
Optional prefix for class names used by the module

Returns string
Inherited from DraggerBase.prefix
- Defined in src/components/DraggerBase/index.ts:33

prevCoords

get prevCoords(): NDraggerBase.IVector2
Returns the previous pointer coordinates.

Returns NDraggerBase.IVector2
Inherited from DraggerBase.prevCoords
- Defined in src/components/DraggerBase/index.ts:100
set prevCoords(value): void
Sets the previous pointer coordinates.
Parameters
- value: NDraggerBase.IVector2
Returns void
Inherited from DraggerBase.prevCoords
- Defined in src/components/DraggerBase/index.ts:107

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
The current properties of the module, which include both static and changeable properties. These can be retrieved dynamically during the module's lifecycle.

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

startCoords

get startCoords(): NDraggerBase.IVector2
Returns the starting pointer coordinates at the beginning of the drag.

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

type

get type(): undefined | "mouse" | "touch"
Returns the type of event ('mouse' or 'touch') being handled.

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

Methods

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Adds a custom callback to the module.
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
  
  The event type to listen for (e.g., 'propsChange', 'destroy').
- action: TAction<CallbacksTypes[T]>
  
  The function to execute when the event is triggered.
- settings: ISettings = {}
  
  Additional settings for the callback.
Returns IAddedCallback
Inherited from DraggerBase.addCallback
- Defined in src/base/Module/index.ts:245

addEventListener

addEventListener<Target, Listener>(element, target, callback, options?): (() => void)
Adds a DOM event listener that will be automatically removed when the module is destroyed.
Type Parameters
- Target extends keyof HTMLElementEventMap
- Listener extends ((event) => void)
Parameters
- element: Document | Element | Window
  
  The target element for the event listener.
- target: Target
  
  The event type to listen for (e.g., 'click', 'resize').
- callback: Listener
  
  The callback function to execute when the event is triggered.
- Optional options: boolean | AddEventListenerOptions
  
  Additional options for the event listener.
Returns (() => void)
- - (): void
  - Returns void
Inherited from DraggerBase.addEventListener
- Defined in src/base/Module/index.ts:261

addPlugin

addPlugin<T>(plugin): void
Adds a plugin to the component. The plugin is initialized upon being added, and the plugin's component property is set to the current component instance.
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
  
  An instance of the Plugin class to be added.
Returns void
Inherited from DraggerBase.addPlugin
- Defined in src/base/Component/index.ts:30

addResponsiveProps

addResponsiveProps(rules): void
Adds responsive property rules to the module. This must be done before initialization.
Parameters
- rules: IResponsive<ChangeableProps>
  
  The responsive property rules to be added.
Returns void
Inherited from DraggerBase.addResponsiveProps
- Defined in src/base/Module/index.ts:159

addViewportCallback

addViewportCallback(target, action, data?): void
Adds a viewport callback that will be automatically removed when the module is destroyed.
Parameters
- target: keyof IViewportCallbackTypes
  
  The viewport target (e.g., width or height).
- action: (() => void)
  
  The callback function to execute when the viewport target changes.
  - - (): void
    - Returns void
- data: undefined | ISettings = {}
  
  Additional data for the callback.
Returns void
Inherited from DraggerBase.addViewportCallback
- Defined in src/base/Module/index.ts:225

cancel

cancel(): void
Cancels the current drag operation and removes runtime events and styles.

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

changeProps

changeProps(props): void
Updates the changeable properties of the module.
Parameters
- props: Partial<ChangeableProps>
  
  The properties to be updated.
Returns void
Inherited from DraggerBase.changeProps
- Defined in src/base/Module/index.ts:174

destroy

destroy(): void
Destroys the module, cleaning up resources, callbacks, and event listeners.

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

init

init(): void
Initializes the module. Calls the internal _init method and marks the module as initialized.

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

Class DraggerDirection<StaticProps, ChangeableProps, CallbacksTypes>

Link

Link

Type Parameters

StaticProps extends NDraggerDirection.IStaticProps = NDraggerDirection.IStaticProps

ChangeableProps extends NDraggerDirection.IChangeableProps = NDraggerDirection.IChangeableProps

CallbacksTypes extends NDraggerDirection.ICallbacksTypes = NDraggerDirection.ICallbacksTypes

Hierarchy

Index

Constructors

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>

Accessors

callbacks

Returns Callbacks<CallbacksTypes>

container

Returns Element | Window

coords

Returns NDraggerBase.IVector2

Parameters

value: NDraggerBase.IVector2

Returns void

isDestroyed

Returns boolean

isDragging

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

prevCoords

Returns NDraggerBase.IVector2

Parameters

value: NDraggerBase.IVector2

Returns void

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

startCoords

Returns NDraggerBase.IVector2

type

Returns undefined | "mouse" | "touch"

Methods

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

addEventListener

Type Parameters

Target extends keyof HTMLElementEventMap

Listener extends ((event) => void)

Parameters

element: Document | Element | Window

target: Target

callback: Listener

Optional options: boolean | AddEventListenerOptions

Returns (() => void)

Returns void

addPlugin

Type Parameters

T extends Plugin<any, any, any, any>

Parameters

plugin: T

Returns void

addResponsiveProps

`Optional` initialProps: StaticProps & ChangeableProps

`Optional` options: boolean | AddEventListenerOptions