Class AnimateOnDrag

Class to manage an element's transform animation on drag

Export

AnimateOnDrag

Index

Constructors

Accessors

Methods

onDragEnd onDragMove onDragStart

Constructors

constructor

new AnimateOnDrag(target: HTMLElement): AnimateOnDrag
Parameters
- target: HTMLElement
Returns AnimateOnDrag
- Defined in OSFramework/OSUI/Behaviors/AnimateOnDrag.ts:59

Accessors

dragParams

get dragParams(): DragParams
Get dragParams object

Returns DragParams

Memberof
OSFramework.Behaviors.AnimateOnDrag
- Defined in OSFramework/OSUI/Behaviors/AnimateOnDrag.ts:107

Methods

onDragEnd

onDragEnd(
    offsetX: number,
    offsetY: number,
    timeTaken: number,
    callback: Generic,
    springProperties?: SpringAnimationConfigs,
): void
Method to handle the gesture end callback
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
- callback: Generic
- OptionalspringProperties: SpringAnimationConfigs
Returns void
{void}

Memberof
OSFramework.Behaviors.AnimateOnDrag
- Defined in OSFramework/OSUI/Behaviors/AnimateOnDrag.ts:122

onDragMove

onDragMove(
    offsetX: number,
    offsetY: number,
    currentX: number,
    currentY: number,
    event: TouchEvent,
): void
Method to handle the gesture move callback
Parameters
- offsetX: number
- offsetY: number
- currentX: number
- currentY: number
- event: TouchEvent
Returns void
{void}

Memberof
OSFramework.Behaviors.AnimateOnDrag
- Defined in OSFramework/OSUI/Behaviors/AnimateOnDrag.ts:185

onDragStart

onDragStart(
    verticalDrag: boolean,
    expectedDirection: OSFramework.OSUI.GlobalEnum.Direction,
    currentX: number,
    currentY: number,
    isOpen: boolean,
    size: string,
): void
Method to handle the gesture start callback
Parameters
- verticalDrag: boolean
- expectedDirection: OSFramework.OSUI.GlobalEnum.Direction
- currentX: number
- currentY: number
- isOpen: boolean
- size: string
Returns void

Memberof
OSFramework.Behaviors.AnimateOnDrag
- Defined in OSFramework/OSUI/Behaviors/AnimateOnDrag.ts:263