kristajg / cozy-holiday

Add some cozy holiday cheer to your website or project! πŸŽπŸŽ„β„οΈ

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

cozy-holiday

🎁 Add cozy pixelated holiday cheer to your React site!

πŸŽ„ Featuring: snow, lights, crackling fireplace, eggnog, & a festive boi.

Cozy Holiday Demo

Installation

npm i --save-dev cozy-holiday

Basic Usage

import CozyHoliday from 'cozy-holiday';

const MyComponent = () => (
  <CozyHoliday />
);

Configuration

prop name: snowIntensity
type: string
description: Controls amount of flakes visible on screen
options:

  • 'mild' (default)
  • 'flurry'
  • 'blizzard'
  • 'snowDayDontComeIntoWork'

example:
<CozyHoliday snowIntensity='flurry' />

prop name: hideIcons
type: array of strings
description: Controls which holiday features are available in the navigation & render. By adding the feature to the array, it becomes unavailable. All features are available by default.
options:

  • 'fire'
  • 'snow'
  • 'lights'
  • 'eggnog'
  • 'cat'

example:
<CozyHoliday hideIcons={['fire', 'eggnog', 'cat']} />

prop name: fireSoundOn
type: boolean
description: If you don't love the soothing sound of a crackling fireplace you totally don't have to listen to it. This isn't Tik Tok.
options:

  • true (default)
  • false

example:
<CozyHoliday fireSoundOn={false} />

About

Add some cozy holiday cheer to your website or project! πŸŽπŸŽ„β„οΈ

License:MIT License


Languages

Language:JavaScript 100.0%