Class ProgressPreloader<StaticProps, ChangeableProps, CallbacksTypes>

Page preloader with smooth progress calculation

Type Parameters

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

Hierarchy

Preloader<StaticProps, ChangeableProps, CallbacksTypes>
- ProgressPreloader

Constructors

constructor

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

Properties

`Protected` `Optional` _animationFrame

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

Animation frame for smooth progress calculation

`Protected` `Optional` _container

_container?: false | HTMLElement

Preloader container

`Protected` _customResources

_customResources: ICustomResourceData[]

Custom resources to be preloaded

`Protected` _endTime

_endTime: number

Preloader end time

`Protected` `Optional` _endTimeline

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

Timeline to finish progress animation

`Protected` _images

_images: HTMLImageElement[]

Images to be preloaded

`Protected` _isHidden

_isHidden: boolean

Preloader is hidden

`Protected` _isToBeHidden

_isToBeHidden: boolean

Preloader is to be hidden

`Protected` _loadedResourcesQuantity

_loadedResourcesQuantity: number

Quantity of loaded resources

`Protected` _progress

_progress: number

Preloader progress

`Protected` _resourcesQuantity

_resourcesQuantity: number

`Protected` _startTime

_startTime: number

Preloader start time

`Protected` _videos

_videos: HTMLVideoElement[]

Videos to be preloaded

Accessors

app

get app(): Application
Vevet Application

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

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

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

container

get container(): undefined | false | HTMLElement
Preloader container

Returns undefined | false | HTMLElement
Inherited from Preloader.container
- Defined in src/components/Preloader/index.ts:35

customResources

get customResources(): ICustomResourceData[]
Custom resources to be preloaded

Returns ICustomResourceData[]
- Defined in src/components/ProgressPreloader/index.ts:58

endTime

get endTime(): number
Preloader end time

Returns number
Inherited from Preloader.endTime
- Defined in src/components/Preloader/index.ts:51

images

get images(): HTMLImageElement[]
Images to be preloaded

Returns HTMLImageElement[]
- Defined in src/components/ProgressPreloader/index.ts:42

isDestroyed

get isDestroyed(): boolean
The module is destroyed

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

isHidden

get isHidden(): boolean
Preloader is hidden

Returns boolean
Inherited from Preloader.isHidden
- Defined in src/components/Preloader/index.ts:69

isInitialized

get isInitialized(): boolean
The module is initialized

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

loadProgress

get loadProgress(): number
Loading progress

Returns number
- Defined in src/components/ProgressPreloader/index.ts:85

loadedResourcesQuantity

get loadedResourcesQuantity(): number
Quantity of loaded resources

Returns number
- Defined in src/components/ProgressPreloader/index.ts:80

name

get name(): string
Module name

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

prefix

get prefix(): string
Module prefix

Returns string
Inherited from Preloader.prefix
- Defined in src/components/Preloader/index.ts:27

progress

get progress(): number
Preloader progress

Returns number
- Defined in src/components/ProgressPreloader/index.ts:93
set progress(val): void
Parameters
- val: number
Returns void
- Defined in src/components/ProgressPreloader/index.ts:97

props

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

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

resourcesQuantity

get resourcesQuantity(): number
Quantity of resources to be preloader

Returns number
- Defined in src/components/ProgressPreloader/index.ts:65

startTime

get startTime(): number
Preloader start time

Returns number
Inherited from Preloader.startTime
- Defined in src/components/Preloader/index.ts:43

totalTime

get totalTime(): number
Total time of page loading before the preloader is to be hidden

Returns number
Inherited from Preloader.totalTime
- Defined in src/components/Preloader/index.ts:58

videos

get videos(): HTMLVideoElement[]
Videos to be preloaded

Returns HTMLVideoElement[]
- Defined in src/components/ProgressPreloader/index.ts:50

Methods

`Protected` _destroy

_destroy(): void
Destroy the component

Returns void
Overrides Preloader._destroy
- Defined in src/components/ProgressPreloader/index.ts:350

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    canPreloadImages: boolean;
    canPreloadVideos: boolean;
    container: string;
    forceEnd: number;
    hideAnimation: number;
    lerp: number;
    preloadCustomSelector: string;
    preloadIgnoreClassName: string;
    resourcesQuantity: number;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    canPreloadImages: boolean;
    canPreloadVideos: boolean;
    container: string;
    forceEnd: number;
    hideAnimation: number;
    lerp: number;
    preloadCustomSelector: string;
    preloadIgnoreClassName: string;
    resourcesQuantity: number;
}
Overrides Preloader._getDefaultProps
- Defined in src/components/ProgressPreloader/index.ts:25

`Protected` _getResources

_getResources(): void
Get resources to be preloaded

Returns void
- Defined in src/components/ProgressPreloader/index.ts:159

`Protected` _handleHidden

_handleHidden(): void
Handle the moment when the preloader is hidden

Returns void
Inherited from Preloader._handleHidden
- Defined in src/components/Preloader/index.ts:174

`Protected` _handleLoaded

_handleLoaded(): void
When the page is fully loaded

Returns void
Inherited from Preloader._handleLoaded
- Defined in src/components/Preloader/index.ts:128

`Protected` _handleLoadedResource

_handleLoadedResource(__namedParameters): void
Event on resource loaded
Parameters
- __namedParameters: IHandleLoadedResourceParameter
Returns void
- Defined in src/components/ProgressPreloader/index.ts:268

`Protected` _handleProgressChange

_handleProgressChange(): void
Event on progress change

Returns void
- Defined in src/components/ProgressPreloader/index.ts:305

`Protected` _init

_init(): void
Init the class

Returns void
Overrides Preloader._init
- Defined in src/components/ProgressPreloader/index.ts:125

`Protected` _onLoaded

_onLoaded(): PCancelable<any>
Catch the moment when the page is fully loaded

Returns PCancelable<any>
Overrides Preloader._onLoaded
- Defined in src/components/ProgressPreloader/index.ts:220

`Protected` _onPropsMutate

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

Returns void
Inherited from Preloader._onPropsMutate
- Defined in src/base/Module/index.ts:197

`Protected` _preloadResources

_preloadResources(): void
Preload all resources

Returns void
- Defined in src/components/ProgressPreloader/index.ts:240

`Protected` _setEvents

_setEvents(): void
Set events

Returns void
Overrides Preloader._setEvents
- Defined in src/components/ProgressPreloader/index.ts:132

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

addResponsiveProps

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

changeProps

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

`Protected` className

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

destroy

destroy(): void
Destroy the module

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

hide

hide(duration?): PCancelable<any>
Hide the preloader
Parameters
- duration: number = ...
Returns PCancelable<any>
Inherited from Preloader.hide
- Defined in src/components/Preloader/index.ts:138

init

init(): void
Initializes the class

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

iterateLoadedResources

iterateLoadedResources(quantityProp?): void
Iterate quantity of loaded resources
Parameters
- quantityProp: number = 1
Returns void
- Defined in src/components/ProgressPreloader/index.ts:291

iterateResourcesQuantity

iterateResourcesQuantity(quantity?): void
Iterate quantity of total resources
Parameters
- quantity: number = 1
Returns void
- Defined in src/components/ProgressPreloader/index.ts:300

onHidden

onHidden(action): undefined | IAddedCallback
Callback for the moment when the preloader is hidden
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns undefined | IAddedCallback
Inherited from Preloader.onHidden
- Defined in src/components/Preloader/index.ts:191

onHide

onHide(action): undefined | IAddedCallback
Callback for the moment when the preloader starts hiding
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns undefined | IAddedCallback
Inherited from Preloader.onHide
- Defined in src/components/Preloader/index.ts:180

`Protected` toggleClassName

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

Class ProgressPreloader<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NProgressPreloader.IStaticProps = NProgressPreloader.IStaticProps

ChangeableProps extends NProgressPreloader.IChangeableProps = NProgressPreloader.IChangeableProps

CallbacksTypes extends NProgressPreloader.ICallbacksTypes = NProgressPreloader.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NProgressPreloader.IStaticProps = NProgressPreloader.IStaticProps

ChangeableProps extends NProgressPreloader.IChangeableProps = NProgressPreloader.IChangeableProps

CallbacksTypes extends NProgressPreloader.ICallbacksTypes = NProgressPreloader.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns ProgressPreloader<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected Optional _animationFrame

Protected Optional _container

Protected _customResources

Protected _endTime

Protected Optional _endTimeline

Protected _images

Protected _isHidden

Protected _isToBeHidden

Protected _loadedResourcesQuantity

Protected _progress

Protected _resourcesQuantity

Protected _startTime

Protected _videos

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

container

Returns undefined | false | HTMLElement

customResources

Returns ICustomResourceData[]

endTime

Returns number

images

Returns HTMLImageElement[]

isDestroyed

Returns boolean

isHidden

Returns boolean

isInitialized

Returns boolean

loadProgress

Returns number

loadedResourcesQuantity

Returns number

name

Returns string

prefix

Returns string

progress

Returns number

Parameters

val: number

Returns void

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

resourcesQuantity

Returns number

startTime

Returns number

totalTime

Returns number

videos

Returns HTMLVideoElement[]

Methods

Protected _destroy

Returns void

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` `Optional` _animationFrame

`Protected` `Optional` _container

`Protected` _customResources

`Protected` _endTime

`Protected` `Optional` _endTimeline

`Protected` _images

`Protected` _isHidden

`Protected` _isToBeHidden

`Protected` _loadedResourcesQuantity

`Protected` _progress

`Protected` _resourcesQuantity

`Protected` _startTime

`Protected` _videos

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
canPreloadImages: boolean;
canPreloadVideos: boolean;
container: string;
forceEnd: number;
hideAnimation: number;
lerp: number;
preloadCustomSelector: string;
preloadIgnoreClassName: string;
resourcesQuantity: number;
}

`Protected` _getResources

`Protected` _handleHidden

`Protected` _handleLoaded

`Protected` _handleLoadedResource

`Protected` _handleProgressChange

`Protected` _init

`Protected` _onLoaded

`Protected` _onPropsMutate

`Protected` _preloadResources

`Protected` _setEvents

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions