Skip to content
This repository has been archived by the owner on Aug 19, 2022. It is now read-only.


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

React Progressive Image

Maintenance Status

react-progressive-image React component for progressive image loading


$ yarn add react-progressive-image

The UMD build is also available on unpkg:

<script src=""></script>

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



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

With Delay

  {src => <img src={src} alt="an image" />}

With loading argument

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

With srcSet

    srcSet: 'small.jpg 320w, medium.jpg 700w, large.jpg 2000w',
    sizes: '(max-width: 2000px) 100vw, 2000px'
  {(src, _loading, srcSetData) => (
      alt="an image"

Component As Placeholder

If you want to use a component, such as a loading spinner, as a placeholder, you can make use of the loading argument in the render callback. It will be true while the main image is loading and false once it has fully loaded. Keep in mind that the placeholder props is required, so you will need to explicitly declare an empty string as it's value if you plan on using a component in the render callback.

const dominantImageColor = '#86356B';
const placeholder = (
    style={{ backgroundColor: dominantImageColor, height: 300, width: 500 }}

<ProgressiveImage src="large-image.jpg" placeholder="">
  {(src, loading) => {
    return loading ? placeholder : <img src={src} alt="an image" />;

Progressive Enhancement and No JavaScript

Since this component relies on JavaScript to replace the placeholder src with the full image src, you should use a fallback image if your application supports environments that do not have JavaScript enabled or is progressively enhanced.

You can do this by adding the fallback image inside of a <noscript> tag in the render callback you provide as the ProgressiveImage component's child.

<ProgressiveImage src="large-image.jpg" placeholder="tiny-image.jpg">
  {src => {
    return (
        <img className="progressive-image" src={src} />
          <img className="progressive-image no-script" src="large-image.jpg" />


Name Type Required Description
children function true returns src, loading, and srcSetData
delay number false time in milliseconds before src image is loaded
onError function false returns error event
placeholder string true the src of the placeholder image
src string true the src of the main image
srcSetData {srcSet: "string", sizes: "string" } false srcset and sizes to be applied to the image

Maintenance Status

Archived: This project is no longer maintained by Formidable. We are no longer responding to issues or pull requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!