vue-mouse-parallax

vue-mouse-parallax

An easy to use Mouse Parallax Component - Made with Vue.js

Demo

vuejs mouse parallax

Installation

npm install --save vue-mouse-parallax

Default import

Install all the components:

import Vue from 'vue'
import VueMouseParallax from 'vue-mouse-parallax'

Vue.use(VueMouseParallax)

Use specific components:

import Vue from 'vue'
import { ParallaxContainer, ParallaxElement } from 'vue-mouse-parallax'

Vue.component('parallax-container', ParallaxContainer)
Vue.component('parallax-element', ParallaxElement)

Browser

<script src="vue.js"></script>
<script src="vue-mouse-parallax/dist/vue-mouse-parallax.common.js"></script>

Usage

In order for the effect to work, the <parallax-element /> should be contained within <parallax-container />

Options can then be passed to <parallax-element /> like so :

<parallax-container>
    <parallax-element :parallaxStrength="10" type="translation" tag="div">
        <h2>Put your content here</h2>
     </parallax-element>
</parallax-container>

Props

parallax-container

Prop	Type	Default Value	Description
animationDuration	Number	1000	Speed of the parallax animation in ms
easing	String	cubic-bezier(0.23, 1, 0.32, 1)	Easing of the parallax animation
tag	String	div	Takes any valid html tag
perspective	Number	1000	Effective for the 'depth' parallax type

parallax-element

Prop	Type	Default Value	Description
parallaxStrength	Number	10	Strength of the Parallax Effect
type	String	'translation'	'translation' - 'rotation' - 'depth'
tag	String	div	Takes any valid html tag

Todo

• Improve nested parallax
• Combine multiple transform types on one element
• filter: drop-shadow() prop on parallax-element
• Translate on one Axis
• Touch events

License

MIT