Skip to content
React component for progressive image loading
Branch: master
Clone or download
boygirl Merge pull request #27 from brybrophy/feature/#18-component-for-place…

Feature/#18 component for placeholder
Latest commit 3fc6294 Oct 15, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Add docs on component as placeholder Sep 26, 2018
src Update d.ts file Sep 20, 2018
.flowconfig Support react 16 and upgrade dependency Nov 2, 2017
.gitignore Ignore and remove .DS_Store Oct 5, 2016
.npmignore Initil commit Sep 29, 2016
.travis.yml Add docs on component as placeholder Sep 26, 2018
webpack.config.umd.js Update UMD webpack config Sep 15, 2018

React Progressive Image

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 argment

<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
You can’t perform that action at this time.