Class Preloader<C, S, M>

Page preloader component that manages the visibility and lifecycle of a loading screen. The module does not provide styling for the container.

Documentation

Type Parameters

C extends IPreloaderCallbacksMap = IPreloaderCallbacksMap
S extends IPreloaderStaticProps = IPreloaderStaticProps
M extends IPreloaderMutableProps = IPreloaderMutableProps

Hierarchy (View Summary)

Module<C, S, M>
- Preloader
  - ProgressPreloader

Index

Constructors

constructor

new Preloader<
    C extends
        IPreloaderCallbacksMap<IPreloaderMutableProps> = IPreloaderCallbacksMap<
        IPreloaderMutableProps,
    >,
    S extends IPreloaderStaticProps = IPreloaderStaticProps,
    M extends IPreloaderMutableProps = IPreloaderMutableProps,
>(
    props?: S & M & Partial<
        {
            [K in string
            | number
            | symbol as `on${Capitalize<string & K>}`]: TCallbacksAction<
                C[K],
                Preloader<C, S, M>,
            >
        },
    >,
    onCallbacks?: Partial<
        {
            [K in string
            | number
            | symbol as `on${Capitalize<string & K>}`]: TCallbacksAction<
                C[K],
                Preloader<C, S, M>,
            >
        },
    >,
): Preloader<C, S, M>
Type Parameters
- C extends IPreloaderCallbacksMap<IPreloaderMutableProps> = IPreloaderCallbacksMap<IPreloaderMutableProps>
- S extends IPreloaderStaticProps = IPreloaderStaticProps
- M extends IPreloaderMutableProps = IPreloaderMutableProps
Parameters
- Optionalprops: S & M & Partial<
      {
          [K in string
          | number
          | symbol as `on${Capitalize<string & K>}`]: TCallbacksAction<
              C[K],
              Preloader<C, S, M>,
          >
      },
  >
- OptionalonCallbacks: Partial<
      {
          [K in string
          | number
          | symbol as `on${Capitalize<string & K>}`]: TCallbacksAction<
              C[K],
              Preloader<C, S, M>,
          >
      },
  >
Returns Preloader<C, S, M>
Overrides Module.constructor
- Defined in src/components/Preloader/index.ts:53

Accessors

callbacks

get callbacks(): Callbacks<CallbacksMap, this>
Retrieves the module's callbacks instance.

Returns Callbacks<CallbacksMap, this>
Inherited from Module.callbacks
- Defined in src/base/Module/index.ts:76

isDestroyed

get isDestroyed(): boolean
Checks if the module has been destroyed.

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

isHidden

get isHidden(): boolean
Returns whether the preloader is currently hidden.

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

name

get name(): string
The name of the module, derived from the class name

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

prefix

get prefix(): string
Optional prefix for classnames used by the module

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

props

get props(): TRequiredProps<MutableProps & StaticProps>
Current properties. Do not mutate these directly, use updateProps instead.

Returns TRequiredProps<MutableProps & StaticProps>
Inherited from Module.props
- Defined in src/base/Module/index.ts:46

Methods

`Protected`_addTempClassName

_addTempClassName(element: Element, className: string): void
Adds a class name on an element, and keeps track of it for removal when the module is destroyed.
Parameters
- element: Element
  The target DOM element.
- className: string
  The class name to toggle.
Returns void
Inherited from Module._addTempClassName
- Defined in src/base/Module/index.ts:209

`Protected`_cn

_cn(...classNames: string[]): string
Helper function to generate classnames with the module's prefix.
Parameters
- ...classNames: string[]
  The class names to generate.
Returns string
A string of class names with the module's prefix applied.
Inherited from Module._cn
- Defined in src/base/Module/index.ts:199

`Protected`_destroy

_destroy(): void
Internal method to handle the destruction of the module. It removes all callbacks, destroys properties, and cleans up event listeners and class names.

Returns void
Inherited from Module._destroy
- Defined in src/base/Module/index.ts:231

_getMutable

_getMutable(): TRequiredProps<M>
Retrieves the default mutable properties.

Returns TRequiredProps<M>
Overrides Module._getMutable
- Defined in src/components/Preloader/index.ts:40

_getStatic

_getStatic(): TRequiredProps<S>
Retrieves the default static properties.

Returns TRequiredProps<S>
Overrides Module._getStatic
- Defined in src/components/Preloader/index.ts:33

`Protected`_handleProps

_handleProps(diff: Partial<M>): void
Method that is called when the module's properties mutate. In most cases, used to handle callbacks.
Parameters
- diff: Partial<M>
Returns void
Inherited from Module._handleProps
- Defined in src/base/Module/index.ts:131

`Protected`_onLoaded

_onLoaded(callback: () => void): void
Handles the page load event, triggering when the page is fully loaded.
Parameters
- callback: () => void
Returns void
- Defined in src/components/Preloader/index.ts:77

destroy

destroy(): void
Destroys the module, cleaning up resources, callbacks, and event listeners.

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

hide

hide(duration: number, callback?: () => void): undefined | () => void
Hides the preloader with a custom animation duration.
Parameters
- duration: number
  The duration of the hide animation (in milliseconds). Applies only when the container is used.
- Optionalcallback: () => void
  The callback to execute when the hide animation is complete.
Returns undefined | () => void
Returns an action destructor.
- Defined in src/components/Preloader/index.ts:105

on

on<T extends string | number | symbol>(
    target: T,
    listener: TCallbacksAction<C[T], Preloader<C, S, M>>,
    settings?: ICallbacksSettings,
): () => void
Adds a custom callback to the module.
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
  The event type to listen for (e.g., 'props', 'destroy').
- listener: TCallbacksAction<C[T], Preloader<C, S, M>>
  The function to execute when the event is triggered.
- settings: ICallbacksSettings = {}
  Additional settings for the callback.
Returns () => void
Inherited from Module.on
- Defined in src/base/Module/index.ts:185

onDestroy

onDestroy(action: () => void): void
Adds a callback on the module's destruction.
Parameters
- action: () => void
  The function to execute during destruction.
Returns void
Inherited from Module.onDestroy
- Defined in src/base/Module/index.ts:167

onHidden

onHidden(action: () => void): () => void
Registers a callback for when the preloader is fully hidden.
Parameters
- action: () => void
  The callback function to execute.
Returns () => void
A destructor.
- Defined in src/components/Preloader/index.ts:192

onHide

onHide(action: () => void): () => void
Registers a callback for when the preloader starts hiding.
Parameters
- action: () => void
  The callback function to execute.
Returns () => void
A destructor.
- Defined in src/components/Preloader/index.ts:172

updateProps

updateProps(props: Partial<M>): void
Change module's mutable properties
Parameters
- props: Partial<M>
Returns void
Inherited from Module.updateProps
- Defined in src/base/Module/index.ts:137

Class Preloader<C, S, M>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Preloader<C, S, M>

Accessors

callbacks

Returns Callbacks<CallbacksMap, this>

isDestroyed

Returns boolean

isHidden

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredProps<MutableProps & StaticProps>

Methods

Protected_addTempClassName

Parameters

Returns void

Protected_cn

Parameters

Returns string

Protected_destroy

Returns void

_getMutable

Returns TRequiredProps<M>

_getStatic

Returns TRequiredProps<S>

Protected_handleProps

Parameters

Returns void

Protected_onLoaded

Parameters

Returns void

destroy

Returns void

hide

Parameters

Returns undefined | () => void

on

Type Parameters

Parameters

Returns () => void

onDestroy

Parameters

Returns void

onHidden

Parameters

Returns () => void

onHide

Parameters

Returns () => void

updateProps

Parameters

Returns void

Settings

On This Page

`Protected`_addTempClassName

`Protected`_cn

`Protected`_destroy

`Protected`_handleProps

`Protected`_onLoaded