In the dynamic landscape of web development, creating visually stunning and immersive components is essential for engaging user experiences. In this detailed guide, we’ll explore the creation of a Vue.js slideshow component that leverages the power of Three.js for 3D graphics and GSAP for smooth animations. This combination allows developers to build a captivating slideshow that goes beyond traditional two-dimensional presentations.
Setting Up the Vue Project:
To begin, create a new Vue project using the Vue CLI. Ensure that Node.js and npm are installed on your machine. If not, download and install them from Node.js official website.
npm install -g @vue/cli
vue create vue-slideshow
cd vue-slideshow
Integrating Three.js and GSAP:
- Install Three.js and GSAP:
npm install three gsap
- Create a
Slideshow.vue
component:
<template>
<div ref="slideshowContainer" class="slideshow-container"></div>
</template>
<script>
import * as THREE from 'three';
import { GSAP } from 'gsap';
export default {
mounted() {
this.initSlideshow();
},
methods: {
initSlideshow() {
const scene = new THREE.Scene();
const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
const renderer = new THREE.WebGLRenderer();
renderer.setSize(window.innerWidth, window.innerHeight);
this.$refs.slideshowContainer.appendChild(renderer.domElement);
const geometry = new THREE.BoxGeometry();
const material = new THREE.MeshBasicMaterial({ color: 0x00ff00 });
const cube = new THREE.Mesh(geometry, material);
scene.add(cube);
camera.position.z = 5;
const animate = () => {
requestAnimationFrame(animate);
// Add your animation logic here
renderer.render(scene, camera);
};
animate();
},
},
};
</script>
<style scoped>
.slideshow-container {
width: 100%;
height: 100vh;
}
</style>
Building the Slideshow Logic:
- Initialize GSAP:
npm install gsap
- Extend the
Slideshow.vue
component:
<script>
import * as THREE from 'three';
import { GSAP } from 'gsap';
export default {
mounted() {
this.initSlideshow();
},
methods: {
initSlideshow() {
// Existing code...
// New GSAP logic
const tl = GSAP.timeline();
tl.to(cube.rotation, { duration: 1, y: Math.PI * 2, ease: 'power2.inOut' });
const animate = () => {
requestAnimationFrame(animate);
// GSAP animation logic
GSAP.updateRoot(time => {
const elapsedTime = time / 1000; // Convert milliseconds to seconds
tl.progress(elapsedTime);
});
renderer.render(scene, camera);
};
animate();
},
},
};
</script>
Expanding the Slideshow:
- Load Images for Slides:
npm install vue-loader url-loader file-loader
- Update
Slideshow.vue
component:
<template>
<div ref="slideshowContainer" class="slideshow-container"></div>
</template>
<script>
import * as THREE from 'three';
import { GSAP } from 'gsap';
export default {
data() {
return {
slides: [
require('@/assets/slide1.jpg'),
require('@/assets/slide2.jpg'),
// Add more slides as needed
],
};
},
mounted() {
this.initSlideshow();
},
methods: {
initSlideshow() {
// Existing code...
const textures = this.slides.map(slide => new THREE.TextureLoader().load(slide));
const materials = textures.map(texture => new THREE.MeshBasicMaterial({ map: texture }));
const cube = new THREE.Mesh(geometry, materials);
scene.add(cube);
// Existing code...
const animate = () => {
requestAnimationFrame(animate);
// GSAP animation logic
GSAP.updateRoot(time => {
const elapsedTime = time / 1000; // Convert milliseconds to seconds
tl.progress(elapsedTime);
});
renderer.render(scene, camera);
};
animate();
},
},
};
</script>
<style scoped>
.slideshow-container {
width: 100%;
height: 100vh;
overflow: hidden;
}
</style>
Running the Application:
Run the following commands to see the slideshow in action:
npm install
npm run serve
Visit http://localhost:8080
in your browser to experience the Vue.js slideshow component with Three.js and GSAP.
Complete implementation of a Vue.js slideshow component working with Three.js and GSAP
Webgl image displacement transitions made simple. A Vue.js slideshow component working with Three.js and GSAP. It works with Vue3 and older versions (until 3.0.1) work with Vue2
vue-displacement-slideshow
Webgl image displacement transitions made simple. A Vue.js slideshow component working with Three.js and GSAP. It works with Vue3 and older versions (until 3.0.1) work with Vue2.
The canvas can be interactive as well by setting the
isInteractive
props totrue
. See theprops
section to find more.
Installation
# using yarn yarn add vue-displacement-slideshow # or using npm npm i vue-displacement-slideshow
⚠️ If you are using this component with Vue2, you have to use this version: 3.0.1
, as the ones that follow only support Vue3. You can install a particular version like this:
# using yarn yarn add [email protected] # or using npm npm i [email protected]
Example
<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" /> </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 in a client-only
component like so :
<client-only> <vue-displacement-slideshow /> </client-only>
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 | |
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.inOut |
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 |
interactionFactor | Number | The factor of the interaction | false | 1 |
interactionDuration | Number | The duration of the interaction | false | 1 |
startAsTransparent | Boolean | Whether the canvas is initially transparent and the first transition goes to the first picture | false | false |
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 |
insertTransparentTexture(index) | Insert a transparent texture at a given index | index : the index of the inserted image, it has the same behavior as the insertImage index parameter | void |
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.
If you set the prop startAsTransparent
to true
, then it adds a texture to your images
array. If you want to remove it after, you can just call the removeImage
method with 0
as the index parameter value.