/ Images

React component for progressive image loading

React component for progressive image loading

React Progressive Image

react-progressive-image React component for progressive image loading.

Installation

Using npm:

$ npm install --save react-progressive-image

The UMD build is also available on unpkg:

<script src="https://unpkg.com/[email protected]/umd/react-progressive-image.min.js"></script>

If you use the UMD build you can find the library on window.ReactProgressiveImage.

Usage

react-progressive-image exports a single React component, ProgressiveImage, which takes a src and placeholder prop, as well as an optional onError function.

src should be the final image you want to load, and placeholder is the image you want to display until src is loaded. placeholder can be anything you want. A typical use case might involve using a smaller version of the image, an inlined version (data URI), or a loading graphic.

ProgressiveImage accepts a render callback as a child, which will be called with the placeholder first, and then src once the image has been loaded.

<ProgressiveImage src='large-image.jpg' placeholder='tiny-image.jpg'>
  {(src) => <img src={src} alt='an image'/>}
</ProgressiveImage>

It will also call the render callback with a second argument, loading, which you can use to quickly determine what image is being rendered. loading will be true when the placeholder is rendered, and false when the full image is rendered.

<ProgressiveImage src='large-image.jpg' placeholder='tiny-image.jpg'>
  {(src, loading) => (
    <img style={{ opacity: loading ? 0.5 : 1 }} src={src} alt='an image'/>
  )}
</ProgressiveImage>

GitHub