Giter VIP home page Giter VIP logo

vue-displacement-slideshow's Introduction

vue-displacement-slideshow

Webgl image displacement transitions made simple. A Vue.js 2.0 slideshow component working with Three.js and GSAP.

Demo

Demo gif

The canvas can be interactive as well by setting the isInteractive props to true. See the props section to find more.

Live demo

DEMO

Installation

NPM

 npm i --save vue-displacement-slideshow

Example

With VueJs 2.0 :

<template>
    <vue-displacement-slideshow
            :images="images"
            displacement="require('../assets/displacement.png')"
            :intensity="0.2"
            :speedIn="1.4"
            :speedOut="1.4"
            ease="expo.out"
            ref="slideshow"></vue-displacement-slideshow>
</template>

<script>
    import VueDisplacementSlideshow from "vue-displacement-slideshow";

    export default {
        components: {
            VueDisplacementSlideshow,
        },
        computed: {
            images() {
                return [
                    require("../assets/images/1.jpg"),
                    require("../assets/images/2.jpg"),
                    require("../assets/images/3.jpg")
                ];
            }
        },
        methods: {
            init() {
                //We loop through all our images by calling the 'next' method of our component every 2 seconds
                setInterval(() => {
                    this.$refs.slideshow.next();
                }, 2000);
            }
        },
        mounted() {
            this.init();
        }
    };
</script>

With Nuxt :

Just wrap the component between a no-ssr tag like so :

<no-ssr>
    <vue-displacement-slideshow />
</no-ssr>

This component is heavily based on this library : https://github.com/robin-dela/hover-effect

Props

name type description required default value
images Array An array containing the paths of the images you wan to use true []
displacement String The path of the displacement image true none
intensity Number The intensity of the displacement false 1
speedIn Number The duration of the animation for the next image, in seconds false 1
speedOut Number The duration of the animation for the previous image, in seconds false 1
ease String The GSAP easing to use false expo.out
preserveAspectRatio Boolean Whether the images keep their aspect ratio (act as background-size : cover (true) or contain (false) false true
isInteractive Boolean Whether the canvas is interactive on mouse move false false
interactionVelocity Object The velocity of the RGB interaction false { x : 7, y : 1 }
angle Number The angle of the transition false Math.PI / 4

Methods

Name Description Params Returns
next Transition to the second image. void
previous Transition to the first image. void
pause Pause the current transition void
play Play the current paused animation void
insertImage(path,index) Insert an image at a given index
  • path : the path of the image
  • index : the index of the inserted image, if not provided, the image will be inserted at the end of the array. It has the same behavior as the splice method (negative number allowed)
a Promise resolved when the image is loaded
removeImage(index) Remove an image at a given index
  • index : the index of the image to remove (must be different from the current image index)
void
goTo(index) Transition to a given image by its index
  • index : the index of the image to transition to
void

Events emitted

Name Description
loaded Fired when the component is ready
animationEnd Fired when the transition is done.

Behavior

The first image of the array is displayed at first. When we call the next method while currently showing the last image, it will go to the first image. When we call the previous method while currently showing the first image, it will go to the last image.

The images are displayed as we would use background-size:cover in CSS.

Contributing

Contributions are welcome ! Follow the instructions in the contributing file

License

MIT

vue-displacement-slideshow's People

Contributors

albancrepel avatar yahtnif avatar stephanedemotte avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.