Interface IProgressPreloaderStaticProps

Static properties for configuring the progress preloader.

interface IProgressPreloaderStaticProps {
    __staticProp?: true;
    container: null | HTMLElement;
    customSelector?: string;
    endDuration?: number;
    hide?: number | false;
    ignoreClassName?: string;
    lerp?: number;
    preloadImages?: boolean;
    preloadVideos?: boolean;
    resourceContainer?: null | HTMLElement;
}

Hierarchy (View Summary)

Properties

__staticProp? container customSelector? endDuration? hide? ignoreClassName? lerp? preloadImages? preloadVideos? resourceContainer?

Properties

Optional__staticProp

__staticProp?: true

container

container: null | HTMLElement

The container for the preloader. Set it to null if you only need the preloader logic.

OptionalcustomSelector

customSelector?: string

Selector for custom resources to preload. Elements should include data-weight and data-loaded attributes. Example: data-weight="10" for a weight of 10, data-loaded="10" when loaded.

Default

'.js-preload'

OptionalendDuration

endDuration?: number

Duration (ms) to complete the preloader if resources are loaded but progress < 1.

Default

500

Optionalhide

hide?: number | false

Defines whether to automatically hide the preloader container.

  • false: Disables the hiding animation, allowing you to manage it manually.
  • number: Specifies the animation duration in milliseconds. This works only if the container is an HTML element.

Default

250

OptionalignoreClassName

ignoreClassName?: string

Class name for elements to exclude from preloading.

Default

'js-preload-ignore'

Optionallerp

lerp?: number

Linear interpolation factor for smooth progress updates. 1 disables interpolation for instant updates.

Default

0.1

OptionalpreloadImages

preloadImages?: boolean

Enables automatic preloading of images.

Default

true

OptionalpreloadVideos

preloadVideos?: boolean

Enables automatic preloading of videos.

Default

false

OptionalresourceContainer

resourceContainer?: null | HTMLElement

Container source for preloader resources.

Default

null

Settings

Member Visibility

On This Page

Properties