animated-slide-in-background
v1.0.10
Published
Adds a slide in background effect to your DOM elements
Downloads
10
Readme
Animated Slide In Background
Adds a sliding background effect to HTML elements.
When the user hovers over an element with this effect activated, a transition effect occurs where the first color slides out and is replaced by the second color.
The effect can be configured with different colors, to slide in at different angles, and allows lifecyle methods to hook into different stages of the animation process.
Demos
There's a Stackblitz which shows the library used as a module. There's also a JSFiddle which demonstrates the library being used from a CDN.
Installation
Install by pulling from NPM or by getting from CDN
NPM
npm i animated-slide-in-background
CDN
<script src="https://unpkg.com/[email protected]/dist/main.js" integrity="" crossorigin="anonymous"></script>
Usage
The background effect can be bound to an element both with data attributes and manually by instantiating the
AnimatedSlideInBackground
class.
Configure using HTML attributes
Add data attributes to configure an element and then call autoBindElements()
to bind background effect to element.
<div
data-asb
data-asb-color="dodgerblue"
data-asb-angle="350"
class="my-element"></div>
autoBindElements();
Configure using Javascript
Manually calling the AnimatedSlideInBackground
class is another way of activating the
effect, but also allows the addition of lifecyle handlers.
<div id="my-element"></div>
const el = document.getElementById('my-element');
function afterEnter() {
el.classList.add('is-visible');
}
function afterLeave() {
el.classList.remove('is-visible');
}
function beforeEnter() {
console.log('before enter');
}
function beforeLeave() {
el.classList.remove('is-visible');
}
const slider = new AnimatedSlideInBackground(el, {
angle: 60,
color: 'hotpink',
beforeEnter,
beforeLeave,
afterEnter,
afterLeave,
});
slider.init();