Class BaseTimeline<StaticProps, ChangeableProps, CallbacksTypes>

BaseTimeline is the base class for the Timeline itself. The difference between the coponents is that BaseTimeline has no autonomous animation.

Type Parameters

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

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- BaseTimeline
  - Timeline

Constructors

constructor

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

Properties

`Protected` _easing

_easing: number

Easing progress

`Protected` _nestedTimelines

_nestedTimelines: {
id: string;
timeline: BaseTimeline<NBaseTimeline.IStaticProps, NBaseTimeline.IChangeableProps, NBaseTimeline.ICallbacksTypes>;
}[]

Nested timelines

Type declaration

id: string
timeline: BaseTimeline<NBaseTimeline.IStaticProps, NBaseTimeline.IChangeableProps, NBaseTimeline.ICallbacksTypes>

`Protected` _progress

_progress: number

Global timeline progress

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

easing

get easing(): number
Easing progress

Returns number
- Defined in src/components/BaseTimeline/index.ts:46

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
Global timeline progress

Returns number
- Defined in src/components/BaseTimeline/index.ts:32
set progress(val): void
Parameters
- val: number
Returns void
- Defined in src/components/BaseTimeline/index.ts:36

props

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

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

Methods

`Protected` _destroy

_destroy(): void
Destroy the module

Returns void
Overrides Component._destroy
- Defined in src/components/BaseTimeline/index.ts:117

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    easing: TEasingType;
    hasNestedEasingProgress: boolean;
    scope: number[];
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    easing: TEasingType;
    hasNestedEasingProgress: boolean;
    scope: number[];
}
Overrides Component._getDefaultProps
- Defined in src/components/BaseTimeline/index.ts:19

`Protected` _handleProgressUpdate

_handleProgressUpdate(): void
Handle progress event

Returns void
- Defined in src/components/BaseTimeline/index.ts:82

`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
Inherited from Component._onPropsMutate
- Defined in src/base/Module/index.ts:197

`Protected` _renderNestedTimelines

_renderNestedTimelines(): void
Render nested timelines

Returns void
- Defined in src/components/BaseTimeline/index.ts:94

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

addNestedTimeline

addNestedTimeline(timeline): {
remove: (() => void);
}
Add a nested timeline
Parameters
- timeline: BaseTimeline<NBaseTimeline.IStaticProps, NBaseTimeline.IChangeableProps, NBaseTimeline.ICallbacksTypes>
Returns {
remove: (() => void);
}
- remove: (() => void)
  - - (): void
    - Returns void
- Defined in src/components/BaseTimeline/index.ts:67

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

`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 BaseTimeline<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NBaseTimeline.IStaticProps = NBaseTimeline.IStaticProps

ChangeableProps extends NBaseTimeline.IChangeableProps = NBaseTimeline.IChangeableProps

CallbacksTypes extends NBaseTimeline.ICallbacksTypes = NBaseTimeline.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NBaseTimeline.IStaticProps = NBaseTimeline.IStaticProps

ChangeableProps extends NBaseTimeline.IChangeableProps = NBaseTimeline.IChangeableProps

CallbacksTypes extends NBaseTimeline.ICallbacksTypes = NBaseTimeline.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns BaseTimeline<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected _easing

Protected _nestedTimelines

Type declaration

id: string

timeline: BaseTimeline<NBaseTimeline.IStaticProps, NBaseTimeline.IChangeableProps, NBaseTimeline.ICallbacksTypes>

Protected _progress

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

easing

Returns number

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

progress

Returns number

Parameters

val: number

Returns void

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

Methods

Protected _destroy

Returns void

Protected _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & { easing: TEasingType; hasNestedEasingProgress: boolean; scope: number[]; }

Protected _handleProgressUpdate

Returns void

Protected _init

Returns void

Protected _onPropsMutate

Returns void

Protected _renderNestedTimelines

Returns void

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

Protected addDestroyableAction

Parameters

action: (() => void)

Returns void

Returns void

addEventListener

Type Parameters

El extends ListenerElement

Target extends keyof HTMLElementEventMap

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` _easing

`Protected` _nestedTimelines

`Protected` _progress

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
easing: TEasingType;
hasNestedEasingProgress: boolean;
scope: number[];
}

`Protected` _handleProgressUpdate

`Protected` _init

`Protected` _onPropsMutate

`Protected` _renderNestedTimelines

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

Returns {
remove: (() => void);
}

`Protected` className

`Rest` ...classNames: string[]

`Protected` toggleClassName