ng-image-appear

AngularJS Module to make images appear with transition as they load.

Wraps the img tag within a wrapper and adds a gif loader in between. No more ugly-looking progressively loading images!

http://arunmichaeldsouza.github.io/ng-image-appear/

Demo on CodePen

This project has also been ported to ReactJS - react-image-appear.

Installation

CDN

Use ng-image-appear directly from jsdelivr CDN

https://cdn.jsdelivr.net/npm/[email protected]/dist/ng-image-appear.min.js

via bower

You can install the package using bower. Make sure you have bower installed, then run :

bower install ng-image-appear

via npm

npm install ng-image-appear

Or, download the latest version and include ng-image-appear.min.js to your project.

Add ngImageAppear as a dependency in your angular app module.

Usage

Include the directive with an img tag in your HTML file with any of the available options.

Include the src and the ng-image-appear directive as an attribute.

Example -

var myApp = angular.module('myApp', ['ngImageAppear']);

myApp.controller('appCtrl', ['$scope', function($scope) {
				
}]);

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear 
	responsive
	transition-duration="1s"
	animation="fillIn"
	animation-duration="1s"
	easing="ease-out"
/> 

Options

transition-duration

This parameter specifies the transition duration for the image to appear. Default value is 700ms.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	transition-duration="4s"
/> 

bg-color

Adds a background color to the image wrapper element.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	bg-color="#50a4e2"
/> 

no-loader

If this option is specified, then no gif loader is shown in the image wrapper element.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	no-loader
/> 

responsive

Use this option to make the image wrapper responsive. In that case the width of the wrapper is calculated in %, otherwise it is calculated in px.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	responsive
/> 

placeholder

Adds a default placeholder in the image wrapper background.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	placeholder
/> 

You can override the default placeholder background and add your own by passing an image link to this option.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	placeholder="http://getuikit.com/docs/images/placeholder_600x400.svg"
/> 

placeholder-class

Use this option to add a CSS class to the placeholder background.

Example -

<style>
	.placeholder-css {
		background-size: contain;
	}
</style>

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	placeholder
	placeholder-class="placeholder-css"
/> 

placeholder-style

Add CSS styles to the placeholder background using this option.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	placeholder
	placeholder-style="background-size: contain;"
/> 

loader-img

Add a custom gif loader in the image wrapper. Default width and height of the loader is 40px. The image must be a gif.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	loader-img="https://cache.dominos.com/nolo/ca/en/010048/assets/build/images/img/spinner.gif"
/> 

loader-class

Use this option to add a CSS class to the loader element.

Example -

<style>
	.loader-css {
		width: 60px; 
		height: 60px; 
		left: calc((100% - 60px) / 2); 
		top: calc((100% - 60px) / 2);
	}
</style>

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	loader-class="loader-css"
/> 

loader-style

Add CSS styles to the loader element using this option.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	loader-styles="width: 60px; height: 60px; left: calc((100% - 60px) / 2); top: calc((100% - 60px) / 2);"
/> 

animation

Add a CSS3 powered animation to the image as it appears. Default animation is fadeIn.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	animation="bounceIn"
/> 

ng-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

animation-duration

This parameter specifies the animation duration for the image to appear. Default value is 700ms.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	animation="fillIn"
	animation-duration="2s"
/> 

easing

Specifies the timing-function for the CSS3 powered transition/animation. Default value is ease-in-out.

Example -

<img 
	src="https://newevolutiondesigns.com/images/freebies/tropical-beach-background-8.jpg" 
	ng-image-appear
	animation="bounceIn"
	easing="ease-out"
/> 

Contributors

| Arun Michael Dsouza| Travis Vignon| Lukas Drgon | | :---: | :---: | :---: |

Support

If you'd like to help support the development of the project, please consider backing me on Patreon -

License

MIT Licensed

Copyright (c) 2016 Arun Michael Dsouza ([email protected])

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.