- Notifications
You must be signed in to change notification settings - Fork61
FormidableLabs/react-progressive-image
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
react-progressive-image React component for progressive image loading
$ yarn add react-progressive-image
The UMD build is also available onunpkg:
<scriptsrc="https://unpkg.com/react-progressive-image@0.1.0/umd/react-progressive-image.min.js"></script>
If you use the UMD build you can find the library onwindow.ReactProgressiveImage.
<ProgressiveImagesrc="large-image.jpg"placeholder="tiny-image.jpg">{src=><imgsrc={src}alt="an image"/>}</ProgressiveImage>
<ProgressiveImagedelay={3000}src="large-image.jpg"placeholder="tiny-image.jpg">{src=><imgsrc={src}alt="an image"/>}</ProgressiveImage>
<ProgressiveImagesrc="large-image.jpg"placeholder="tiny-image.jpg">{(src,loading)=>(<imgstyle={{opacity:loading ?0.5 :1}}src={src}alt="an image"/>)}</ProgressiveImage>
<ProgressiveImagesrc="medium.jpg"srcSetData={{srcSet:'small.jpg 320w, medium.jpg 700w, large.jpg 2000w',sizes:'(max-width: 2000px) 100vw, 2000px'}}placeholder="tiny-image.jpg">{(src,_loading,srcSetData)=>(<imgsrc={src}srcSet={srcSetData.srcSet}sizes={srcSetData.sizes}alt="an image"/>)}</ProgressiveImage>
If you want to use a component, such as a loading spinner, as a placeholder, you can make use of theloading 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 theplaceholder props isrequired, 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.
constdominantImageColor='#86356B';constplaceholder=(<divstyle={{backgroundColor:dominantImageColor,height:300,width:500}}/>);<ProgressiveImagesrc="large-image.jpg"placeholder="">{(src,loading)=>{returnloading ?placeholder :<imgsrc={src}alt="an image"/>;}}</ProgressiveImage>;
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 theProgressiveImage component's child.
<ProgressiveImagesrc="large-image.jpg"placeholder="tiny-image.jpg">{src=>{return(<div><imgclassName="progressive-image"src={src}/><noscript><imgclassName="progressive-image no-script"src="large-image.jpg"/></noscript></div>);}}</ProgressiveImage>
| Name | Type | Required | Description |
|---|---|---|---|
| children | function | true | returnssrc,loading, andsrcSetData |
| 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 |
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!
About
React component for progressive image loading
Resources
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors12
Uh oh!
There was an error while loading.Please reload this page.