Skip to content
/ vanta Public
forked from tengbao/vanta

Vanta JS: Plug & play animated 3D backgrounds for your website

License

Notifications You must be signed in to change notification settings

tirth-hs/vanta

 
 

Repository files navigation

Vanta JS

alt text

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.

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', // element id or DOM object reference
  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:

You can import vanta.xxxxx.min.js as follows. (Make sure three.js or p5.js is also included.)

  import * as THREE from './three.min.js'
  import BIRDS from './vanta.birds.min.js'

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

Local Dev:

Clone the repo, run npm install and npm run dev, and go to localhost:8080.

Credits

About

Vanta JS: Plug & play animated 3D backgrounds for your website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 76.2%
  • CSS 18.0%
  • HTML 5.8%