Skip to content

OpenFlyGroup/snowfall

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@openflygroup/snowfall

npm version npm bundle size npm downloads GitHub Workflow Status Coverage License GitHub issues

❄️ Beautiful, customizable snowfall effects for React with accumulation and fading animations.

Features

  • 🎨 Fully customizable snowflakes (size, color, shape, speed)
  • 🏔️ Snow accumulation on DOM elements
  • ⏱️ Automatic fading after specified time
  • 🎮 Interactive controls panel
  • 📱 Responsive and performant
  • 🎯 TypeScript support
  • 🎨 Tailwind CSS compatible
  • 🔧 Multiple presets and themes
  • 🎪 Extensible and pluggable

Quick Start

npm install @openflygroup/snowfall zustand
import {
  SnowCanvas,
  SnowAccumulation,
  SnowControls,
} from "@openflygroup/snowfall";

function App() {
  return (
    <>
      <SnowCanvas accumulationElements={[".card", "h1"]} />
      <SnowAccumulation elementId="header" />
      <SnowControls />

      <h1 className="relative">Winter Wonderland</h1>
      <div className="card relative">Snow will accumulate here</div>
    </>
  );
}

Styles

By default, the library imports its own prebuilt Tailwind‑based stylesheet.
If you prefer an explicit import, you can do:

import "@openflygroup/snowfall/styles";

Documentation

  • Docs site (GitHub Pages): https://openflygroup.github.io/snowfall/
  • Storybook with live examples: https://openflygroup.github.io/snowfall/storybook/

Contributing

Please read our Contributing Guide.

License

MIT © OpenFly Group

About

❄️ Beautiful, customizable snowfall effects for React with accumulation and fading animations.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published