Skip to content
This repository has been archived by the owner on Sep 27, 2019. It is now read-only.

Simple animation library which uses CSS transitions in the background and allows animating dimension percentages.

License

Notifications You must be signed in to change notification settings

Competec/simple-animation-js

Repository files navigation

GitHub license Build Status NPM version NPM downloads GitHub issues codecov semantic-release

simple-animation-js

Simple animation library which uses CSS transitions in the background and allows animating dimension percentages with scrollWidth and scrollHeight.

Installation

npm install simple-animation-js

Documentation

The documentation is found under this link or in the gh-pages branch. The starting point of the documentation is the Module simpleAnimation.

Contributing contributions welcome

If you want to contribute to this project please commit with the npm run commit command, this will secure the automatic semantic versioning.

Example

const simpleAnimationJs = require('simple-animation-js');
const elementToAnimate = document.getElementById('testDiv');
const options = {
	target: elementToAnimate,
	animations: [{
		attribute: 'height',
		animateTo: '100%',
		duration: 400,
		easing: 'ease-in',
		pctToScroll: true
	},
	{
		attribute: 'opacity',
		animateTo: 1
	}],
	defaultDuration: 350,
	defaultEasing: 'ease-out'
};
simpleAnimationJs(options);