Skip to main content

Callbacks

note

All Preloader callbacks (loaded, requestHide, hide, hidden, …) are available.
loaded fires when smoothed progress reaches 1, after all resources are resolved and optional endDuration finish.

progress​

Fired each animation frame while progress is updating — during Raf smoothing and during the endDuration finish timeline (timelineUpdate).

const preloader = new ProgressPreloader({
container: document.getElementById('container'),
onProgress: (_data, { progress }) => console.log(progress),
});

or:

const destruct = preloader.on('progress', () =>
console.log(preloader.progress),
);

// Cancel the callback
destruct();

timelineStart​

Fired when the endDuration finish timeline starts.
Runs when all resources are loaded (loadProgress >= 1) but smoothed progress is still below 1. Skipped when progress is already 1.

const preloader = new ProgressPreloader({
container: document.getElementById('container'),
onTimelineStart: () => console.log('timelineStart'),
});

or:

const destruct = preloader.on('timelineStart', () =>
console.log('timelineStart'),
);

// Cancel the callback
destruct();

timelineUpdate​

Fired on every frame of the finish timeline.

Provides timeline progress (progress — linear, eased — with easing). Smoothed progress is updated on the same tick — progress also fires.

const preloader = new ProgressPreloader({
container: document.getElementById('container'),
onTimelineUpdate: ({ progress, eased }) => {
console.log(progress, eased, preloader.progress);
},
});

or:

const destruct = preloader.on('timelineUpdate', ({ progress, eased }) => {
console.log(progress, eased);
});

// Cancel the callback
destruct();

timelineEnd​

Fired when the finish timeline completes and smoothed progress reaches 1.
loaded may fire on the same frame.

const preloader = new ProgressPreloader({
container: document.getElementById('container'),
onTimelineEnd: () => console.log('timelineEnd'),
});

or:

const destruct = preloader.on('timelineEnd', () => console.log('timelineEnd'));

// Cancel the callback
destruct();

resource​

Fired whenever a resource updates its loaded weight —
both DOM-based (data-loaded changes) and virtual resources.

const preloader = new ProgressPreloader({
container: document.getElementById('container'),
onResource: ({ id, weight, loaded }) => {
console.log(id, `loaded ${loaded} / ${weight}`);
},
});

or:

const destruct = preloader.on('resource', ({ id, weight, loaded }) => {
console.log(id, `loaded ${loaded} / ${weight}`);
});

// Cancel the callback
destruct();