lbry-desktop/ui/effects/use-lazy-loading.js
infinite-persistence 7cbb7a54aa
Handle browsers that don't support IntersectionObserver (#1739)
* Remove ad-handling in videojs.jsx

Primary impetus is to remove unnecessary IntersectionObserver usage, but it should be removed anyway because:
- no longer relevant today with Adnimation's script.
- we also globally hide floating ads now, so no more invisible divs.
- the code is wrongly placed -- it's not the responsibility of the Videojs component.

* use-lazy-loaded: skip if IntersectionObserver is not supported

## Issue
Page not loading in older Safari (e.g. ipad air 2)

## Approach
Instead of using a polyfill (which comes with implementation caveats), just not apply the lazy-loading for those old browsers. Not lazy-loading is better than not loading at all, plus this is way easier to test (even by just reading the code) than testing out the polyfill implementation's caveats.

The cons is we would need the polyfill if we use it in other places in the future.

## Code Changes
Factor out the src-setting code, and use it directly when IntersectionObserver is not found.
2022-06-23 08:10:27 -04:00

84 lines
2.4 KiB
JavaScript

// @flow
import type { ElementRef } from 'react';
import React, { useEffect } from 'react';
/**
* Helper React hook for lazy loading images
* @param elementRef - A React useRef instance to the element to lazy load.
* @param backgroundFallback
* @param yOffsetPx - Number of pixels from the viewport to start loading.
* @param {Array<>} [deps=[]] - The dependencies this lazy-load is reliant on.
*/
export default function useLazyLoading(
elementRef: { current: ?ElementRef<any> },
backgroundFallback: string = '',
yOffsetPx: number = 500,
deps: Array<any> = []
) {
const [srcLoaded, setSrcLoaded] = React.useState(false);
const threshold = 0.01;
function calcRootMargin(value) {
const devicePixelRatio = window.devicePixelRatio || 1.0;
if (devicePixelRatio < 1.0) {
return Math.ceil(value / devicePixelRatio);
}
return Math.ceil(value * devicePixelRatio);
}
function loadImgFromDataset(target, backgroundFallback, setSrcLoadedFn) {
// lazy-loaded <img>:
if (target.dataset.src) {
// $FlowFixMe
target.src = target.dataset.src;
setSrcLoadedFn(true);
// No fallback handling here (clients have access to 'onerror' on the image ref).
return;
}
// lazy-loaded `background-image`:
if (target.dataset.backgroundImage) {
if (backgroundFallback) {
const tmpImage = new Image();
tmpImage.onerror = () => {
target.style.backgroundImage = `url(${backgroundFallback})`;
};
tmpImage.src = target.dataset.backgroundImage;
}
target.style.backgroundImage = `url(${target.dataset.backgroundImage})`;
}
}
useEffect(() => {
if (!elementRef.current) {
return;
}
if (!window.IntersectionObserver) {
loadImgFromDataset(elementRef.current, backgroundFallback, setSrcLoaded);
return;
}
const lazyLoadingObserver = new IntersectionObserver(
(entries, observer) => {
entries.forEach((entry) => {
if (entry.intersectionRatio >= threshold) {
const { target } = entry;
observer.unobserve(target);
loadImgFromDataset(target, backgroundFallback, setSrcLoaded);
}
});
},
{
root: null,
rootMargin: `0px 0px ${calcRootMargin(yOffsetPx)}px 0px`,
threshold: [threshold],
}
);
// $FlowFixMe
lazyLoadingObserver.observe(elementRef.current);
}, deps);
return srcLoaded;
}