Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf(demo): lazy render example tiles #1896

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

perf(demo): lazy render example tiles #1896

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6cb9144
demo: only render ever visible tiles
williaster Dec 20, 2024
f9f9830
tweak
williaster Dec 20, 2024
4921403
remove ref dep
williaster Dec 20, 2024
6b4c6a6
back to useEffect
williaster Dec 21, 2024
417d5fc
lint
williaster Dec 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 51 additions & 11 deletions packages/visx-demo/src/components/GalleryTile.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, { useCallback, useEffect, useRef, useState } from 'react';

Check failure on line 1 in packages/visx-demo/src/components/GalleryTile.tsx

View workflow job for this annotation

GitHub Actions / build 

'useCallback' is defined but never used
import Link from 'next/link';
import ParentSize from '@visx/responsive/lib/components/ParentSize';
import { WidthAndHeight } from '../types';
Expand All @@ -18,6 +18,43 @@
const renderLinkWrapper = (url: string | undefined, node: React.ReactNode) =>
url ? <Link href={url}>{node}</Link> : node;

/**
* hook which returns if the ref was ever visible.
* used for better perf/not rendering all tiles on load.
*/
function useEverVisible() {
const ref = useRef();
const [everVisible, setIsVisible] = useState(false);

useEffect(() => {
const observer = new IntersectionObserver(
(entries) => {
entries.forEach((entry) => {
setIsVisible((visible) => visible || entry.isIntersecting);
});
},
{
root: null, // viewport is the root
threshold: 0.01,
},
);

let curr;
if (ref.current) {
curr = ref.current;
observer.observe(ref.current);
}

return () => {
if (curr) {
observer.unobserve(curr);
}
};
}, []);

return { everVisible, ref };
}
Copy link
Member

@indiesquidge indiesquidge Dec 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about this hook instead?

function useIntersectionObserver() {
  const [entry, setEntry] = useState<IntersectionObserverEntry | null>(null);
  const prevObserver = useRef<IntersectionObserver | null>(null);

  const ref = useCallback((node: Element) => {
    if (prevObserver.current) {
      prevObserver.current.disconnect();
      prevObserver.current = null;
    }

    const observer = new IntersectionObserver(
      ([entry]) => {
        setEntry(entry);
      },
      { threshold: 0.01, root: null },
    );

    observer.observe(node);
    prevObserver.current = observer;
  }, []);

  return [ref, entry];
}

This could be a better approach for a few reasons:

  1. I think useIntersectionObserver as a name feels like it more directly reflects its functionality, while useEverVisible is more abstract.
  2. I think using disconnect is better because it completely removes the observer and stops watching all elements, ensuring proper cleanup, whereas unobserve only stops watching a specific element without cleaning up the observer itself, which can lead to memory leaks if not handled properly.
  3. We can return the full IntersectionObserverEntry, giving access to more useful visibility data (maybe you don't want or care about this though since we're only using it to check if an element is visible or not).
  4. We are only observing one element at a time in the hook, so even though the callback of the IntersectionObserver always returns an array of entries, the array will always have just one entry, so we don't need to loop over every entry.
  5. The hook has fewer concerns about state tracking and effects.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dig it! this is a great suggestion for all the reasons you listed, I was just being lazy (hah!) :)


export default function GalleryTile<ExampleProps extends WidthAndHeight>({
description,
detailsHeight = 76,
Expand All @@ -28,21 +65,24 @@
tileStyles,
title,
}: Props<ExampleProps>) {
const { everVisible, ref } = useEverVisible();
return (
<>
{renderLinkWrapper(
exampleUrl,
<div className="gallery-tile" style={tileStyles}>
<div ref={ref} className="gallery-tile" style={tileStyles}>
<div className="image">
<ParentSize>
{({ width, height }) =>
React.createElement(exampleRenderer, {
width,
height: height + (title || description ? detailsHeight : 0),
...exampleProps,
} as ExampleProps)
}
</ParentSize>
{everVisible && (
<ParentSize>
{({ width, height }) =>
React.createElement(exampleRenderer, {
width,
height: height + (title || description ? detailsHeight : 0),
...exampleProps,
} as ExampleProps)
}
</ParentSize>
)}
</div>
{(title || description) && (
<div className="details" style={detailsStyles}>
Expand Down
Loading