0.0.10 • Published 7 months ago

jschristmas v0.0.10

Weekly downloads
-
License
ISC
Repository
github
Last release
7 months ago

jschristmas 🎄

A lightweight JavaScript package to add Christmas effects to your website. Perfect for adding some holiday cheer to your web applications!

Features

  • ❄️ Snowstorm effect with customizable settings
  • More to come (maybe) 🤓

Installation

You can install the package using npm:

npm install jschristmas

Or you can download the script from CDN:

<script src="https://cdn.jsdelivr.net/npm/jschristmas@0.0.10/dist/index.browser.min.js"></script>

Quick Start

import JSChristmas from 'jschristmas';

const christmas = new JSChristmas();

// Add snow effect
christmas.snowStorm();

Snow Effect ❄️

Add beautiful falling snowflakes to your website:

christmas.snowStorm({
    maxSnowflakes: 200,
    fallSpeed: 1.25,
    stopAfter: 5000 // Stop after 5 seconds
});

Snow Options

OptionTypeDefaultDescription
onlyOnChristmasDaybooleanfalseOnly show snow on December 25th
colorstring"white"Color of the snowflakes, can be a hex code or a CSS color name
maxSnowflakesnumber200Maximum number of snowflakes
particlesPerThousandPixelsnumber0.1Density of snowflakes
fallSpeednumber1.25Speed multiplier for falling snow
stopAfternumbernullStop generating snow after X milliseconds

Examples

Heavy Snow Effect

christmas.snowStorm({
    maxSnowflakes: 450,
    fallSpeed: 1.7,
    particlesPerThousandPixels: 0.3
});

Christmas Day Only With Red Snowflakes

christmas.snowStorm({
    onlyOnChristmasDay: true,
    maxSnowflakes: 250,
    color: "#fe4242"
});

License

ISC

Author

Alex0x47, creator of:

0.0.10

7 months ago

0.0.9

7 months ago

0.0.8

7 months ago

0.0.7

7 months ago

0.0.6

7 months ago

0.0.5

7 months ago

0.0.4

7 months ago

0.0.3

7 months ago

0.0.2

7 months ago

0.0.1

7 months ago