Dependency-free library for lazyloading iframes
Dependency-free library for lazyloading iframes. Demo
Because embedded content takes time to load.
Lazyframe creates a responsive placeholder for embedded content and requests it when the user interacts with it. This decreases the page load and idle time.
Lazyframe comes with brand-like themes for Youtube and Vimeo.
NPM
$ npm install lazyframe --saveBower
$ bower install lazyframeJavaScript ES6 imports
import lazyframe from "lazyframe";Include JavaScript in html
Sass import
@import 'src/scss/lazyframe'Include css in html
// Passing a selector
lazyframe(".lazyframe");
// Passing a nodelist
let elements = document.querySelectorAll(".lazyframe");
lazyframe(elements);
// Passing a jQuery object
let elements = $(".lazyframe");
lazyframe(elements);You can pass general options to lazyframe on initialization. Element-specific options (most options) are set on data attributes on the element itself.
General options and corresponding defaults
lazyframe(elements, {
debounce: 250,
lazyload: true,
autoplay: true,
// Callbacks
onLoad: (lazyframe) => console.log(lazyframe),
onAppend: (iframe) => console.log(iframe),
onThumbnailLoad: (img) => console.log(img),
});debounceValue (in milliseconds) for when the update function should run after the user has scrolled. More here
lazyloadSet this to false if you want all API calls and local images to be loaded on page load (instead of when the element is in view).
autoplaySet this to false to remove autoplay from the allow attribute on the iframe tag i.e if set this to false if you want don't want your Youtube video to automatically start playing once the user clicks on the play icon.
onLoadCallback function for when a element is initialized.
onAppendCallback function for when the iframe is appended to DOM.
onThumbnailLoadCallback function with the thumbnail URL
data-vendorAttribute for theming lazyframe. Currently supported values are youtube, youtube_nocookie and vimeo.
data-titleAttribute for custom title. Leave empty to get value from noembed.com.
data-thumbnailAttribute for custom thumbnail. Leave empty to get value from noembed.com.
data-srcThe source of what you want to lazyload.
data-ratioThe ratio of the lazyframe. Possible values: 16:9, 4:3, 1:1
data-initinviewSet this to true if you want the resource to execute (for example video to play) when the element is in view.
MIT. © 2016 Viktor Bergehall
No open issues yet, or sync has not completed.