Class SlideProgress<StaticProps, ChangeableProps, CallbacksTypes>

Slide progress handler

Type Parameters

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

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- SlideProgress

Constructors

constructor

new SlideProgress<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?, canInit?): SlideProgress<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NSlideProgress.IStaticProps = NSlideProgress.IStaticProps
- ChangeableProps extends NSlideProgress.IChangeableProps = NSlideProgress.IChangeableProps
- CallbacksTypes extends NSlideProgress.ICallbacksTypes = NSlideProgress.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
- canInit: boolean = true
Returns SlideProgress<StaticProps, ChangeableProps, CallbacksTypes>
Overrides Component.constructor
- Defined in src/components/SlideProgress/index.ts:79

Properties

`Protected` _animationFrame

_animationFrame: AnimationFrame<NAnimationFrame.IStaticProps, NAnimationFrame.IChangeableProps, NAnimationFrame.ICallbacksTypes>

Animation frame

`Protected` _canDragMove

_canDragMove: boolean = false

Can drag

`Protected` _currentHandler

_currentHandler: "drag" | "wheel" = 'wheel'

Current handler

`Protected` _direction

_direction: 1 | -1 = 1

Direction

`Protected` _dragger

_dragger: DraggerMove<NDraggerMove.IStaticProps, NDraggerMove.IChangeableProps, NDraggerMove.ICallbacksTypes>

Dragger events

`Protected` _progressLerp

_progressLerp: IWithLerp = ...

Progress (current and target)

`Protected` `Optional` _stickyEndTimeout

_stickyEndTimeout?: Timeout

Sticky timeout

`Protected` `Optional` _timelineTo

_timelineTo?: Timeline<NTimeline.IStaticProps, NTimeline.IChangeableProps, NTimeline.ICallbacksTypes>

Progress timeline

`Protected` _wheelIntensity

_wheelIntensity: number = 0

Wheel intensity

Accessors

app

get app(): Application
Vevet Application

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

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

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

isDestroyed

get isDestroyed(): boolean
The module is destroyed

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

isInitialized

get isInitialized(): boolean
The module is initialized

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

name

get name(): string
Module name

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

prefix

get prefix(): string
Module prefix

Returns string
Inherited from ComponentClass.prefix
- Defined in src/base/Module/index.ts:78

progress

get progress(): number
Progress

Returns number
- Defined in src/components/SlideProgress/index.ts:52

props

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

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

steppedProgress

get steppedProgress(): number
Stepped progress

Returns number
- Defined in src/components/SlideProgress/index.ts:57

Methods

`Protected` _checkCanDragMove

_checkCanDragMove(absDiff): boolean
Check if can move
Parameters
- absDiff: IVector2
Returns boolean
- Defined in src/components/SlideProgress/index.ts:155

`Protected` _destroy

_destroy(): void
Destroy the module

Returns void
Overrides Component._destroy
- Defined in src/components/SlideProgress/index.ts:366

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    dragDirection: string;
    dragSpeed: number;
    dragThreshold: number;
    ease: number;
    friction: number;
    hasDrag: boolean;
    hasWheel: boolean;
    max: number;
    min: number;
    step: number;
    stepThreshold: number;
    stickyEndDuration: number;
    wheelSpeed: number;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    dragDirection: string;
    dragSpeed: number;
    dragThreshold: number;
    ease: number;
    friction: number;
    hasDrag: boolean;
    hasWheel: boolean;
    max: number;
    min: number;
    step: number;
    stepThreshold: number;
    stickyEndDuration: number;
    wheelSpeed: number;
}
Overrides Component._getDefaultProps
- Defined in src/components/SlideProgress/index.ts:23

`Protected` _getNearestStep

_getNearestStep(value): number
Get nearest stepped value to given progress
Parameters
- value: number
Returns number
- Defined in src/components/SlideProgress/index.ts:225

`Protected` _goStickyEnd

_goStickyEnd(): void
Sticky to the nearest step

Returns void
- Defined in src/components/SlideProgress/index.ts:300

`Protected` _handleAnimationFrame

_handleAnimationFrame(): void
Callback on animation frame

Returns void
- Defined in src/components/SlideProgress/index.ts:251

`Protected` _handleDrag

_handleDrag(data): void
Handle drag move event
Parameters
- data: IMoveParameter
Returns void
- Defined in src/components/SlideProgress/index.ts:178

`Private` _handleDragEnd

_handleDragEnd(): void
Handler drag end event

Returns void
- Defined in src/components/SlideProgress/index.ts:218

`Protected` _handleWheel

_handleWheel(event): void
Handle wheel event
Parameters
- event: WheelEvent
Returns void
- Defined in src/components/SlideProgress/index.ts:114

`Protected` _init

_init(): void
Inner extra initialization

Returns void
Inherited from Component._init
- Defined in src/base/Module/index.ts:221

`Protected` _onPropsMutate

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

Returns void
Overrides Component._onPropsMutate
- Defined in src/components/SlideProgress/index.ts:107

`Protected` _updateCurrentProgress

_updateCurrentProgress(ease): void
Interpolate current progress & launch callbacks if needed
Parameters
- ease: number
Returns void
- Defined in src/components/SlideProgress/index.ts:285

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 Component.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 Component.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 Component.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 Component.addPlugin
- Defined in src/base/Component/index.ts:21

addResponsiveProps

addResponsiveProps(rules): void
Add responsive rules
Parameters
- rules: IResponsive<ChangeableProps>
Returns void
Inherited from Component.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 Component.addViewportCallback
- Defined in src/base/Module/index.ts:231

changeProps

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

`Protected` className

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

destroy

destroy(): void
Destroy the module

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

init

init(): void
Initializes the class

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

render

render(): void
Render scene

Returns void
- Defined in src/components/SlideProgress/index.ts:280

to

to(__namedParameters): void
Animate progress to a certain value
Parameters
- __namedParameters: IToProps
Returns void
- Defined in src/components/SlideProgress/index.ts:324

`Protected` toggleClassName

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

Class SlideProgress<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NSlideProgress.IStaticProps = NSlideProgress.IStaticProps

ChangeableProps extends NSlideProgress.IChangeableProps = NSlideProgress.IChangeableProps

CallbacksTypes extends NSlideProgress.ICallbacksTypes = NSlideProgress.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NSlideProgress.IStaticProps = NSlideProgress.IStaticProps

ChangeableProps extends NSlideProgress.IChangeableProps = NSlideProgress.IChangeableProps

CallbacksTypes extends NSlideProgress.ICallbacksTypes = NSlideProgress.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns SlideProgress<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected _animationFrame

Protected _canDragMove

Protected _currentHandler

Protected _direction

Protected _dragger

Protected _progressLerp

Protected Optional _stickyEndTimeout

Protected Optional _timelineTo

Protected _wheelIntensity

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

progress

Returns number

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

steppedProgress

Returns number

Methods

Protected _checkCanDragMove

Parameters

absDiff: IVector2

Returns boolean

Protected _destroy

Returns void

Protected _getDefaultProps

Protected _getNearestStep

Parameters

value: number

Returns number

Protected _goStickyEnd

Returns void

Protected _handleAnimationFrame

Returns void

Protected _handleDrag

Parameters

data: IMoveParameter

Returns void

Private _handleDragEnd

Returns void

Protected _handleWheel

Parameters

event: WheelEvent

Returns void

Protected _init

Returns void

Protected _onPropsMutate

Returns void

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` _animationFrame

`Protected` _canDragMove

`Protected` _currentHandler

`Protected` _direction

`Protected` _dragger

`Protected` _progressLerp

`Protected` `Optional` _stickyEndTimeout

`Protected` `Optional` _timelineTo

`Protected` _wheelIntensity

`Protected` _checkCanDragMove

`Protected` _destroy

`Protected` _getDefaultProps

`Protected` _getNearestStep

`Protected` _goStickyEnd

`Protected` _handleAnimationFrame

`Protected` _handleDrag

`Private` _handleDragEnd

`Protected` _handleWheel

`Protected` _init

`Protected` _onPropsMutate

`Protected` _updateCurrentProgress

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]

`Protected` toggleClassName