Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robin-dela/hover-effect
Javascript library to draw and animate images on hover
https://github.com/robin-dela/hover-effect
Last synced: about 1 month ago
JSON representation
Javascript library to draw and animate images on hover
- Host: GitHub
- URL: https://github.com/robin-dela/hover-effect
- Owner: robin-dela
- License: mit
- Created: 2018-03-27T14:10:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T00:32:24.000Z (over 1 year ago)
- Last Synced: 2024-10-15T21:21:37.900Z (3 months ago)
- Language: HTML
- Size: 59.4 MB
- Stars: 1,790
- Watchers: 25
- Forks: 304
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-web-animation - Hover-effect - JavaScript library to draw and animate images on hover. (Canvas)
README
# Hover effect
Javascript library to draw and animate images on hover.
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ZGDNS5D28SFWQ)
[**DEMO**](https://tympanus.net/Development/DistortionHoverEffect/)
[**ARTICLE**](https://tympanus.net/codrops/2018/04/10/webgl-distortion-hover-effects/)
## Example
## Use locally
To load the images you'll need to view the demo via a web server, simply go to the demo's folder location and type `python -m SimpleHTTPServer 8000` in your terminal. Then access the demo in your browser by typing: `localhost:8000`
## Basic usage
This helper needs [Three.js](https://threejs.org) and [gsap](https://greensock.com/) to do the transition, so you need to include it before this little helper.
Then you only need a `div` element in HTML to start animating things with a piece of code like this:
```html
var myAnimation = new hoverEffect({
parent: document.querySelector('.my-div'),
intensity: 0.3,
image1: 'images/myImage1.jpg',
image2: 'images/myImage2.jpg',
displacementImage: 'images/myDistorsionImage.png'
});
```
## Node JS usage
This helper can also be used in node js environments. Three.js and TweenMax scripts are included as dependencies in the package so you don't need to manually include them.
### Install
```
npm install hover-effect
```
### Import
```js
import hoverEffect from 'hover-effect'
```
### Init
Initialize just as you would in the basic usage example above.
## Options
### Mandatory parameters
| Name | Type | Default | Description |
|-------------------------|-----------------|-----------------|-------------|
|`parent` | `Dom element` | `null` | The DOM element where the animation will be injected. The images of the animation will take the parent's size. |
|`image1` | `Image` | `null` | The first `Image` of the animation. |
|`image2` | `Image` | `null` | The second `Image` of the animation. |
|`displacementImage` | `Image` | `null` | The `Image` used to do the transition between the 2 main images. |
### Optional parameters
| Name | Type | Default | Description |
|-------------------------|-----------|-----------------|-------------|
|`intensity` | `Float` | `1` | Used to determine the intensity of the distortion effect. 0 is no effect and 1 is full distortion. |
|`intensity1` | `Float` | `intensity` | Overrides the distortion intensity of the first image. |
|`intensity2` | `Float` | `intensity` | Overrides the distortion intensity of the second image. |
|`angle` | `Float` | `Math.PI / 4` | Angle of the distortion effect in Radians. Defaults to Pi / 4 (45 degrees). |
|`angle1` | `Float` | `angle` | Overrides the distortion angle for the first image. |
|`angle2` | `Float` | `-angle * 3` | Overrides the distortion angle for the second image. |
|`speedIn` | `Float` | `1.6` | Speed of the inbound animation (in seconds). |
|`speedOut` | `Float` | `1.2` | Speed of the outbound animation (in seconds). |
|`hover` | `Boolean` | `true` | if set to false the animation will not be triggered on hover (see `next` and `previous` function to interact) |
|`easing` | `String` | `Expo.easeOut` | Easing of the transition, see [greensock easing](https://greensock.com/ease-visualizer)|
|`video` | `Boolean` | `false` | Defines if you want to use videos instead of images (note: you need 2 videos, it doesn't work with one image and one video.) |
|`imagesRatio` | `Float` | `1` | Specify a value if you want a `background: cover` type of behaviour, otherwise it will apply a square aspect ratio. usage: `image height / image width` example: `1080 / 1920` |
### Methods
| Name | Description |
|-------------------------|-------------------------|
|`next` | Transition to the second image. |
|`previous` | Transition to the first image. |
## Credits
Thanks to :
- [Codrops](https://twitter.com/crnacura) for the creation of the example
- [Aarni Koskela](https://github.com/akx/) for the improvements
- [Celso White](https://github.com/celsowhite) for the multiple module formats
## Made with it
- [Codepen demo](https://codepen.io/alxrbrown/pen/GxVQLr) and [Medium article](https://medium.com/@alxrbrown/create-a-distortion-hover-effect-using-webgl-32fc1ab50d24) by Alex Brown
- [https://stimmt.digital/en/](https://stimmt.digital/en/)
- [https://www.fabiofantolino.com/en](https://www.fabiofantolino.com/en)
- [Youtube tutorial](https://www.youtube.com/watch?v=o0zlX1E7l0A)
- [https://www.youtube.com/watch?v=9kcOQdJHyIo](https://www.youtube.com/watch?v=9kcOQdJHyIo)
- [https://www.estudionk.com/en](https://www.estudionk.com/en)
- [https://github.com/AlbanCrepel/vue-displacement-slideshow](https://github.com/AlbanCrepel/vue-displacement-slideshow)
- [https://digitalpresent.io/about](https://digitalpresent.io/about)
- [https://www.couleecreative.com/](https://www.couleecreative.com/)
- [https://two.zero.nyc/](https://two.zero.nyc/)
- [https://www.danilodemarco.com/](https://www.danilodemarco.com/)
- [https://lsce.com/](https://lsce.com/)
- [http://vadimtyurin.com/](http://vadimtyurin.com/)