Interface DraggableOptionsStore
interface DraggableOptionsStore {
tween: boolean;
tweenOptions: QuickTweenOptions;
get tweenDuration(): number;
set tweenDuration(duration: number): void;
get tweenEase(): EasingReference;
set tweenEase(ease: EasingReference): void;
reset(): void;
resetTween(): void;
resetTweenOptions(): void;
subscribe(
this: void,
run: Subscriber<DraggableOptionsStore>,
invalidate?: Invalidator<DraggableOptionsStore>,
): Unsubscriber;
}
tween: boolean;
tweenOptions: QuickTweenOptions;
get tweenDuration(): number;
set tweenDuration(duration: number): void;
get tweenEase(): EasingReference;
set tweenEase(ease: EasingReference): void;
reset(): void;
resetTween(): void;
resetTweenOptions(): void;
subscribe(
this: void,
run: Subscriber<DraggableOptionsStore>,
invalidate?: Invalidator<DraggableOptionsStore>,
): Unsubscriber;
}
Hierarchy
- Readable<DraggableOptionsStore>
- DraggableOptionsStore (View Summary)
Index
Accessors
Methods
Properties
Accessors
tweenDuration
- get tweenDuration(): number
Returns number
Get tween duration.
- set tweenDuration(duration: number): void
Parameters
- duration: number
Set tween duration.
Returns void
- duration: number
tweenEase
Returns EasingReference
Get easing function or easing function name.
Parameters
- ease: EasingReference
Set easing function by name or direct function.
Returns void
- ease: EasingReference
Methods
reset
Resets all options data to initial values.
Returns void
resetTween
Resets tween enabled state to initial value.
Returns void
resetTweenOptions
Resets tween options to initial values.
Returns void
subscribe
- subscribe(
this: void,
run: Subscriber<DraggableOptionsStore>,
invalidate?: Invalidator<DraggableOptionsStore>,
): UnsubscriberSubscribe on value changes.
Parameters
- this: void
- run: Subscriber<DraggableOptionsStore>
subscription callback
Optionalinvalidate: Invalidator<DraggableOptionsStore>cleanup callback
Returns Unsubscriber
Provides an interface of the draggable action options support / Readable store to make updating / setting draggable options much easier. When subscribing to the options instance returned by draggable.options the Subscriber handler receives the entire instance.