README.md

Vanta JS

View gallery & customize effects at www.vantajs.com →

3D animated backgrounds for your website. Select & customize an effect, and add it to your site with a few lines of code. Powered by three.js or p5.js.

View gallery & customize effects at www.vantajs.com →

Basic usage:

<script src="three.r92.min.js"></script>
<script src="vanta.waves.min.js"></script>
<script>
  VANTA.WAVES('#my-background')
</script>

View fiddle →

More options:

VANTA.WAVES({
  el: '#my-background',
  color: 0x000000,
  waveHeight: 20,
  shininess: 50,
  waveSpeed: 1.5,
  zoom: 0.75
})

Each effect has different parameters. Explore them all!

Cleanup:

var effect = VANTA.WAVES('#my-background')
effect.destroy() // e.g. call this in React's componentWillUnmount

Usage In React:

Make sure you've included the right files in the page. Once vanta.xxxxx.min.js is included, you can call window.VANTA.XXXXX(...).

  class MyComponent extends React.Component {
    componentDidMount() {
      this.effect = window.VANTA.BIRDS({
        el: "#my-element"
      })
    }
    componentWillUnmount() {
      if (this.effect) this.effect.destroy()
    }
    render() {
      return <div id="my-element"></div>
    }
  }

Credits

• Birds effect from https://threejs.org/examples/?q=birds#webgl_gpgpu_birds by @zz85
• Fog effect from https://thebookofshaders.com/13/ by @patriciogonzalezvivo
• Clouds effect from https://www.shadertoy.com/view/XslGRr by Inigo Quilez
• Clouds2 effect from https://www.shadertoy.com/view/lsBfDz by Rune Stubbe
• Trunk, Topology effects from http://generated.space/ by Kjetil Midtgarden Golid @kgolid