Class Preloader<StaticProps, ChangeableProps, CallbacksTypes>

Page preloader

Type Parameters

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

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- Preloader
  - ProgressPreloader

Constructors

constructor

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

Properties

`Protected` `Optional` _container

_container?: false | HTMLElement

Preloader container

`Protected` _endTime

_endTime: number

Preloader end time

`Protected` _isHidden

_isHidden: boolean

Preloader is hidden

`Protected` _isToBeHidden

_isToBeHidden: boolean

Preloader is to be hidden

`Protected` _startTime

_startTime: number

Preloader start time

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

container

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

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

endTime

get endTime(): number
Preloader end time

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

isDestroyed

get isDestroyed(): boolean
The module is destroyed

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

isHidden

get isHidden(): boolean
Preloader is hidden

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

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
Overrides ComponentClass.prefix
- Defined in src/components/Preloader/index.ts:27

props

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

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

startTime

get startTime(): number
Preloader start time

Returns number
- 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
- Defined in src/components/Preloader/index.ts:58

Methods

`Protected` _destroy

_destroy(): void
Destroy the component

Returns void
Inherited from Component._destroy
- Defined in src/base/Component/index.ts:39

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
container: string;
hideAnimation: number;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
container: string;
hideAnimation: number;
}
Overrides Component._getDefaultProps
- Defined in src/components/Preloader/index.ts:19

`Protected` _handleHidden

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

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

`Protected` _handleLoaded

_handleLoaded(): void
When the page is fully loaded

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

`Protected` _init

_init(): void
Init the class

Returns void
Overrides Component._init
- Defined in src/components/Preloader/index.ts:98

`Protected` _onLoaded

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

Returns PCancelable<any>
- Defined in src/components/Preloader/index.ts:123

`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` _setEvents

_setEvents(): void
Set module event

Returns void
- Defined in src/components/Preloader/index.ts:105

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

hide

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

init

init(): void
Initializes the class

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

onHidden

onHidden(action): undefined | IAddedCallback
Callback for the moment when the preloader is hidden
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns undefined | IAddedCallback
- 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
- 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 Component.toggleClassName
- Defined in src/base/Module/index.ts:284

Class Preloader<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NPreloader.IStaticProps = NPreloader.IStaticProps

ChangeableProps extends NPreloader.IChangeableProps = NPreloader.IChangeableProps

CallbacksTypes extends NPreloader.ICallbacksTypes = NPreloader.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NPreloader.IStaticProps = NPreloader.IStaticProps

ChangeableProps extends NPreloader.IChangeableProps = NPreloader.IChangeableProps

CallbacksTypes extends NPreloader.ICallbacksTypes = NPreloader.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns Preloader<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected Optional _container

Protected _endTime

Protected _isHidden

Protected _isToBeHidden

Protected _startTime

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

container

Returns undefined | false | HTMLElement

endTime

Returns number

isDestroyed

Returns boolean

isHidden

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

startTime

Returns number

totalTime

Returns number

Methods

Protected _destroy

Returns void

Protected _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & { container: string; hideAnimation: number; }

Protected _handleHidden

Returns void

Protected _handleLoaded

Returns void

Protected _init

Returns void

Protected _onLoaded

Returns PCancelable<any>

Protected _onPropsMutate

Returns void

Protected _setEvents

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)

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` `Optional` _container

`Protected` _endTime

`Protected` _isHidden

`Protected` _isToBeHidden

`Protected` _startTime

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
container: string;
hideAnimation: number;
}

`Protected` _handleHidden

`Protected` _handleLoaded

`Protected` _init

`Protected` _onLoaded

`Protected` _onPropsMutate

`Protected` _setEvents

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]

`Protected` toggleClassName