fritzmg/contao-lazy-load-element

Contao extension to allow lazy loading of content elements or modules.

1.0.1 2024-05-05 16:21 UTC

Requires

• php: >=7.4
• contao/core-bundle: ^4.13

LGPL-3.0-or-later

• Fritz Michael Gschwantner

• module
• content
• lazy
• element
• contao
• load

README

Contao Lazy Load Element

Contao extension to allow lazy loading of content elements or modules.

When installed, this extension provides an additional content element where you can define another content element or module to be lazy loaded on page load. You also have the possibility to let the element reload periodically, once it has been loaded for the first time. And you are able to define, whether the element should only load once it is in the viewport.

To enable this functionality you must enable jQuery in the page layout.

When an element gets loaded or reloaded, either the event lazyload or lazyload-reload will be triggered on that element. This way you can execute your own JavaScript, once an element got loaded (for example to initialize other scripts on the loaded content).

$('#myLazyLoadElement').on('lazyload', function(event)
{
	// …
});

There is also a stylesheet included by default that shows an AJAX loader circle while the element is being loaded or reloaded. To remove it completely you can use this style:

.ce_lazyload:before,
.ce_lazyload:after,
.mod_lazyload:before,
.mod_lazyload:after {
	display: none;
}

Or simply change the styles to your liking. Have a look at the default styles in assets/lazyload.scss.