README.md

SiriWaveJS

Have you ever thought on how to get the Siri wave effect on your website or mobile app?

SiriWaveJS is a library that easily allows you to get this effect.

Embed the script... and Surf!

See the live CodePen Example

Usage

<div id="siri-container"></div>
<script src="/path/to/your/siriwave.js"></script>
<script>
var siriWave = new SiriWave({
	container: document.getElementById('siri-container'),
	width: 640,
	height: 200
});
</script>

Constructor options

canvas (DOM Object, default: document.body)

The DOM container where the canvas to draw the wave is added.

[speed] (Number, from 0 to 1, default: 0.1)

The speed of the wave.

[amplitude] (Number, from 0 to 1, default: 1)

The noise (amplitude) of the wave.

[frequency] (Number, from 0 to N, default: 1)

The noise (amplitude) of the wave.

[color] (String, Color, default: `#fff')

The color of the wave, in hexadecimal form (#336699, #FF0)

API

start()

Start the animation

stop()

Stop the animation.

Projects/examples that uses this script

• The Capitol - The Official Government of Panem (Hunger Games Mockingjay Part 1 website)
• http://blog.kidliaa.com/demo/siri%20wave/

Some math