react-progressive-image

> 编程语言

Open source

React component for progressive image loading

725 stars0 likes1 views

Website GitHub

About

React component for progressive image loading

React Progressive Image

react-progressive-image React component for progressive image loading

Install

bash

$ yarn add react-progressive-image

The UMD build is also available on unpkg:

xml

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

Examples

Simple

javascript


  {src => }

With Delay

javascript


  {src => }

With loading argument

javascript


  {(src, loading) => (
    
  )}

With srcSet

javascript


  {(src, _loading, srcSetData) => (
    
  )}

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.

javascript

const dominantImageColor = '#86356B';
const placeholder = (
  

    );
  }}

Props

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!