0.2.4 • Published 6 years ago

background-wave-transition v0.2.4

Weekly downloads
-
License
ISC
Repository
-
Last release
6 years ago

Background Wave Transition

  • A background wave transition component with pixi.js.
  • Here is an example.

How to use

First

npm install background-wave-transition

Base

import WaveTransition from 'background-wave-transition';

const transition = new WaveTransition({
  element: document.getElementById('container'),
  width: 1280,
  height: 800,
  textures: [
    '/background-wave-transition/images/kon-min.jpeg',
    '/background-wave-transition/images/kon2-min.png',
    '/background-wave-transition/images/kon3-min.jpeg'
  ],
  animationOptions: {}
});

Methods

  // jump to index
  transition.goto(index: number);

  // go to prev
  transition.goPrev();

  // go to next
  transition.goNext();

  // resize
  transition.resize(width: number, height: number);

  // destroy
  transition.destroy();

Params

attributedefaultValuedescription
elementnonetarget element
widthdocument.body.clientWidthcanvas width
heightwindow.innerHeightcanvas height
textures[]background image array
onAnimationStart() => {}trigger when animation start
onAnimationEnd() => {}trigger when animation end
onLoadComplete() => {}trigger when textures loaded
animationOptions.duration2animation duration
animationOptions.initialTime1first shockwave's time
animationOptions.timePulse0.02shockwave's time increase per frame
animationOptions.initialAmplitude30shockwave's amplitude
animationOptions.amplitudePulse0.6shockwave's amplitude decrease per frame
animationOptions.alphaPulse0.01layer's alpha change per frame
animationOptions.wavelength300shockwave's wavelength
animationOptions.waveCount3shockwave count
animationOptions.radius2000shockwave's radius