https://github.com/queen-raae/let-it-snow
https://github.com/queen-raae/let-it-snow
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/queen-raae/let-it-snow
- Owner: queen-raae
- Created: 2024-12-17T11:22:51.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-18T09:12:57.000Z (6 months ago)
- Last Synced: 2024-12-30T12:45:37.031Z (6 months ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# @raae/let-it-snow
_Add some old school cheer 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 or two or three from Queen Raae 👑
### 1-on-1 Emergency Call
Are you stuck on a reef in the sharky waters of the World Wide Web? Check out [1-on-1 Emergency Call](https://queen.raae.codes/gatsby-emergency/) with Queen Raae to get friendly advice you can put into action immediately from a seasoned web developer.
### Stay updated and get to know Queen Raae & family
Stay updated on the script and get to know Queen Raae & family by [subscribing](https://queen.raae.codes/emails/?utm_source=readme&utm_campaign=let-it-snow) to emails (roughly twice a month).
## How to use
Add the script to your website.
```html
```
## Script Options
### Colors
You can decide the color of the snow flakes. Each snowflake gets a random color from the list.\
**Type:** Comma separated list of hex colors, or css variable names resolving to hex colors.\
**Default:** `"#fff"`
```html
```
### Intensity
You can choose the intensity of the snow.\
**Type**: One of "light", "regular" or "blizzard".\
**Default:** `"regular"`
```html
```
### Duration
You can decide how long the snow should fall for.\
**Type**: Positive integer of seconds.\
**Default:** `"15"`
```html
```
### Season
You may decide the time of year the snow should fall.\
**Type**: Comma separated dates, starting with the first day of the season and ending with the last day of the season.\
**Default:** `"December 1, January 4"`
```html
```
### Log Level
You can decide the log level of the script.\
**Type**: One of "error", "warn", "info" or "silent".\
**Default:** `"warn"`
```html
```
## Powered by Canvas Confetti 🎉
Under the hood this plugin uses the amazing [Canvas Confetti](https://github.com/catdad/canvas-confetti) by [@kirilv](https://twitter.com/kirilv).
### Questions, Feedback and Suggestions
Do not be shy!
If you have any questions, feedback or suggestions head on over to [discussions](https://github.com/queen-raae/let-it-snow/discussions).
### Bugs
If you find a bug please open an [issue](https://github.com/queen-raae/let-it-snow/issues) and/or create a pull request to fix it.