Skip to content

Harness the power of Intersection Observers for simple list virtualization in React

License

Notifications You must be signed in to change notification settings

daleperforce/react-render-if-visible

 
 

Repository files navigation

React RenderIfVisible

Harness the power of Intersection Observers for simple list virtualization in React.

This tiny React component is a drop-in list virtualization alternative that defers rendering of its children until it is on or near the screen. Unlike other virtualization libraries, it takes about one minute to integrate and doesn't require you to change your code other than wrapping each item in <RenderIfVisible></RenderIfVisible>.

It works equally well with responsive item heights, responsive grids, non-flat lists, and any other HTML that would normally make other virtualization libraries complicated to implement.

Advantages over other virtualization techniques:

  • No need for a flat list
  • Works with any DOM nesting structure
  • Is completely decoupled from infinite-scroll or pagination
  • Works for responsive grids with no extra configuration
  • Easy to drop in - just wrap your list items with <RenderIfVisible></RenderIfVisible>
  • Doesn't require a wrapper around your entire list and doesn't care if other elements are interspersed with the list items
  • Doesn't care how scrolling works for your situation (i.e. is it window scroll, or scrolling within a div with overflow: scroll)
  • It is tiny - 46 lines - and has no dependencies (apart from React as a peer dependency).

This solution has been used successfully in production on NightCafe Creator for 9+ months.

Read more about the background and development of this component on dev.to.

Install and integrate in 1 minute

First, install the component from npm.

npm install react-render-if-visible --save

Then, import the component and wrap each child with it.

import React from 'react'
import RenderIfVisible from 'react-render-if-visible'
import MyListItem from './list-item' 

const ESTIMATED_ITEM_HEIGHT = 200

export const MyItemList = (items) => (
  <div className="my-list">
    {items.map(item => (
      <RenderIfVisible defaultHeight={ESTIMATED_ITEM_HEIGHT}>
        <MyListItem item={item} />
      </RenderIfVisible>
    ))}
  </div>
)

Props

  • defaultHeight?: number Default: 300 - An estimate of the element's height.
  • visibleOffset?: number Default: 1000 - How far outside the viewport (or root element) in pixels should elements be considered visible?
  • root?: HTMLElement Default: null - Root element passed to IntersectionObserver.
  • children: React.ReactNode - The component(s)/element(s) for which to defer rendering.

About

Harness the power of Intersection Observers for simple list virtualization in React

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 85.8%
  • JavaScript 14.2%