Skip to main content

Accessors

note

All Module accessors are available in this class.

isLoaded​

Type: boolean

Whether the load signal has fired and loaded was emitted.

  • false until page load
  • becomes true before hide() can run
const preloader = new Preloader({
container: document.getElementById('container'),
hide: false,
});

preloader.isLoaded; // false

preloader.on('loaded', () => {
preloader.isLoaded; // true
preloader.hide(500);
});

isHidden​

Type: boolean

Returns whether the preloader is currently hidden.
This becomes true only after:

  • the page is fully loaded, and
  • the hiding animation (automatic or manual) is completed.
const preloader = new Preloader({
container: document.getElementById('container'),
});

preloader.isHidden; // detect final hidden state

isHiding​

Type: boolean

Whether hide() has started but hidden has not fired yet.

preloader.on('hide', () => {
console.log(preloader.isHiding); // true
console.log(preloader.isHidden); // false — fade in progress
});

preloader.on('hidden', () => {
console.log(preloader.isHidden); // true
});