Giter Club home page Giter Club logo

cozy-holiday's Introduction

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} />

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.