@raae/gatsby-plugin-let-it-snow

Add some old school fun to your site with falling snow this holiday season ❄️

Heavily inspired by my memory of snow falling on my WordPress blog way back when…

A message from Queen @raae

Learn how to get the most out of Gatsby and stay updated on the plugin by subscribing to emails from yours truly.

How to install

npm install @raae/gatsby-plugin-let-it-snow

or

yarn add @raae/gatsby-plugin-let-it-snow

How to use

module.exports = {
  plugins: [
    `@raae/gatsby-plugin-let-it-snow`
  ],
}

Options

You can pass an array of colors to use via the plugin options

  {
    resolve: "@raae/gatsby-plugin-let-it-snow",
    options: {
      colors: ["#fff000", "#ff00ff", "#00ff00"],
    },
  },

You can choose the intensity of the snow. Accepted values in increasing intensity: “light”, “regular” and “blizzard”. Default value if non given: “regular”

  {
    resolve: "@raae/gatsby-plugin-let-it-snow",
    options: {
      intensity: "blizzard",
    },
  },

Powered by Canvas Confetti 🎉

Under the hood this plugin uses the amazing Canvas Confetti by @kirilv.

How to contribute with code

Getting started

  • Fork the repo
  • Clone your fork
  • Install the packages: yarn install
  • Run the demo: yarn develop

To be able to have both the demo and plugin in the same repo we use yarn workspaces.

  • Plugin code is in the /plugin folder,
  • and the demo code is in the /demo folder.

Do your thing

Solve an issue or do something else!

Create a Pull Request

To get your changes merged into the project create a Pull Request from your fork.

How to contribute in other ways

Questions, Feedback and Suggestions

If you have any questions, feedback or suggestions head on over to discussions.

Bugs

If you find a bug please open an issue and/or create a pull request to fix it.