Snowfall :: Stay cool

The perfect snow effect for your Winter themed website!

Suggested use: attach it as a fixed background to your page with the content displayed over the top. Check out this example.

Features

• Easy to use
• Beautiful
• Highly configurable | API docs | Config editor
• Consistent density of snowflakes, regardless of screen size
• No bunching on resize
• Scheduling, so you can set it and forget it
• React wrapper

Instructions

First, add a div with an ID of snowfall to your page.

<div id="snowfall"></div>
Copy

It's recommended that you make it full screen and attach it to the background, something like this.

<style>
  #snowfall {
    position: fixed;
    inset: 0;
    pointer-events: none;
    z-index: -1;
  }
</style>
Copy

If you're using a CDN, add the following

<script src="https://cdn.jsdelivr.net/npm/@erikwatson/snowfall@4.1/dist/index.min.js"></script>
<script>
  snowfall.start({
    layers: [{}]
  })
</script>
Copy

Otherwise, install it with your favourite package manager and include it in your projects build step.

npm install @erikwatson/snowfall
Copy

import snowfall from '@erikwatson/snowfall'

snowfall.start({
  layers: [{}]
})
Copy

Custom configs

Same as above but we pass a config object. Your config overrides the default settings.

If you're using TypeScript, import the UserConfig type too.

import snowfall, { UserConfig } from '@erikwatson/snowfall'

const config: UserConfig = {
  layers: [
    {
      colour: '#8d90b7'
    }
  ]
}

snowfall.start(config)
Copy

Scheduling

Same as the above, but we pass a schedule config and the optional snowfall config to the .schedule(user_schedule, user_config) function.

If you're using TypeScript, import the UserSchedule type too.

import snowfall, { UserSchedule } from '@erikwatson/snowfall'

const userSchedule: UserSchedule = {
  from: { month: 12, day: 1 },
  to: { month: 12, day: 31 }
}

const config: UserConfig = {
  layers: [
    {
      colour: '#8d90b7'
    }
  ]
}

snowfall.schedule(userSchedule, config)
Copy

CDN Links

• Latest 4.x (minified): https://cdn.jsdelivr.net/npm/@erikwatson/snowfall@4/dist/index.min.js
• Latest 4.x (unminified): https://cdn.jsdelivr.net/npm/@erikwatson/snowfall@4/dist/index.js
• Specific version: https://cdn.jsdelivr.net/npm/@erikwatson/snowfall@4.0.0/dist/index.min.js

Author

• Erik Watson