react-image-appear
Version:
ReactJS component to make images appear with transition as they load.
304 lines (199 loc) • 8.67 kB
Markdown
<img src="https://github.com/ArunMichaelDsouza/react-image-appear/raw/master/icon.png" width="250" height="auto" alt="react-image-appear icon"/>
# react-image-appear [](https://badge.fury.io/js/react-image-appear) [](https://www.npmjs.com/package/react-image-appear) [](https://travis-ci.org/ArunMichaelDsouza/react-image-appear) <span class="badge-patreon"><a href="https://www.patreon.com/arunmichaeldsouza" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-blue.svg" alt="Patreon donate button" /></a></span>
ReactJS component to make images appear with transition as they load.
> Wraps an ``img`` within a placeholder element and adds a gif loader in between. No more ugly-looking progressively loading images!
This project has also been ported to AngularJS 1.x - [ng-image-appear](https://github.com/ArunMichaelDsouza/ng-image-appear).
<br/>
## Installation
#### via npm
```bash
npm install react-image-appear --save
```
#### via yarn
```bash
yarn add react-image-appear
```
<br/>
## Usage
Import the component and provide the ``src`` with any of the available [props](#props).
```jsx
import ReactImageAppear from 'react-image-appear';
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
animation="zoomIn"
animationDuration="1s"
/>
```
<br/>
## Props
#### ``src {string} | required``
The image source.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
/>
```
<br/>
#### ``className {string}``
Classes to be applied to the image.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
className="my-image"
/>
```
<br/>
#### ``loader {string}``
Adds a custom loader to the component. When not provided, applies a default one.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
loader="https://cache.dominos.com/nolo/ca/en/010048/assets/build/images/img/spinner.gif"
/>
```
<br/>
#### ``loaderStyle {object}``
Adds custom styling to the loader.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
loaderStyle={{ border: "2px solid red" }}
/>
```
<br/>
#### ``loaderClass {string}``
Adds CSS classes to the loader.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
loaderClass="my-loader"
/>
```
<br/>
#### ``placeholder {boolean | string}``
Adds a placeholder background to the component.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
placeholder
/>
```
You can override the default placeholder background and add your own by passing an image URL to this prop.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
placeholder="http://getuikit.com/docs/images/placeholder_600x400.svg"
/>
```
<br/>
#### ``placeholderStyle {object}``
Adds custom styling to the placeholder.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
placeholderStyle={{ border: "2px solid red", backgroundColor: 'black' }}
/>
```
<br/>
#### ``placeholderClass {string}``
Adds CSS classes to the placeholder.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
loaderClass="my-placeholder"
/>
```
<br/>
#### ``animation {string} | Default: fadeIn``
Add a CSS3 powered animation to the image as it appears.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
animation="bounceIn"
/>
```
react-image-appear has the following built-in CSS3 animations -
##### ``fadeIn (default)``
##### ``fadeInUp``
##### ``fadeInRight``
##### ``fadeInDown``
##### ``fadeInLeft``
##### ``bounceIn``
##### ``bounceInUp``
##### ``bounceInRight``
##### ``bounceInDown``
##### ``bounceInLeft``
##### ``flipInX``
##### ``flipInY``
##### ``zoomIn``
##### ``blurIn``
##### ``blurInUp``
##### ``blurInRight``
##### ``blurInDown``
##### ``blurInLeft``
##### ``fillIn``
<br/>
#### ``animationDuration {string} | Default: 700ms``
Specifies the animation duration for the image to appear.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
animation="bounceIn"
animationDuration="1s"
/>
```
<br/>
#### ``easing {string} | Default: ease-in-out``
Specifies the timing-function for the CSS3 powered animation.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
animation="bounceIn"
easing="ease-in"
/>
```
<br/>
#### ``showLoader {boolean} | Default: true``
Specifies whether to show the loader or not.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
showLoader={false}
/>
```
<br/>
#### ``onClick {function}``
Callback to be called when the image is clicked.
```jsx
<ReactImageAppear
src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg"
onClick={handleImageClick}
/>
```
<br/>
## Testing
ReactImageAppear uses the [jest](https://facebook.github.io/jest/) test runner along with [enzyme](http://airbnb.io/enzyme/) for easier assertion and manipulation. Run the following command to start the jest test runner -
```bash
npm test
```
<br/>
## Contributors
| [<img src="https://avatars3.githubusercontent.com/u/4924614" width="100px;"/><br /><sub><b>Arun Michael Dsouza</b></sub>](https://github.com/ArunMichaelDsouza)<br />| [<img src="https://avatars1.githubusercontent.com/u/8732349" width="100px;"/><br /><sub><b>Patrick</b></sub>](https://github.com/pcw0002)<br />| [<img src="https://avatars2.githubusercontent.com/u/2981250" width="100px;"/><br /><sub><b>Stefan</b></sub>](https://github.com/stnwk)<br />| [<img src="https://avatars3.githubusercontent.com/u/3776302?s=400&v=4" width="100px;"/><br /><sub><b>Tim Carr</b></sub>](https://github.com/xaphod)<br />|
| :---: | :---: | :---: | :---: |
<br/>
## Support
If you'd like to help support the development of the project, please consider backing me on Patreon -
[<img src="https://arunmichaeldsouza.com/img/patreon.png" width="180px;"/>](https://www.patreon.com/bePatron?u=8841116)
<br/>
## License
MIT Licensed
Copyright (c) 2018 Arun Michael Dsouza (amdsouza92@gmail.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.