night-night

1.0.6 • Public • Published

Lambda School Student Badge

night-night - Make your website sleep at night

Night Night is a simple program that allows you to put your website to sleep at bedtime, encouraging your users to go to bed, better supporting their health, wellbeing, and happiness.

See Demo

NPM JavaScript Style Guide Code Size Codacy Badge

Install

npm install --save night-night
yarn add night-night

Usage

import React, { Component } from 'react'
 
import NightNight from 'night-night'
 
class Example extends Component {
  render () {
    return (
      <NightNight day={6} dayMin={0} night={22} nightMin={0} expireTime={4} />
    )
  }
}

Variables

  • day = Start of day hour (0-23)
  • dayMin = Start of day min (0-60)
  • night = Start of day hour (0-23)
  • nightMin = Start of day min (0-60)
  • expireTime = Amount of time until Night is disabled (In Hours) for when user continues to site.

Contribute To Our Project

Help us make everyones life a little bit better and add this to your website. Also add a feature to improve the use for everyone.

  • Help Us Style
    • Create a new theme and we will let the user select which theme they want to use.To add to the project fork the github and after adding and testing make a merge request and we will review it.
  • Update NPM Package
    • Allow users to customise the project more. Create new or improve current functionality. To add to the project fork the github and after adding and testing make a merge request and we will review it.
  • Update JS Version
    • If you don't know react js add your changes to the js file in src and we will port it over to our npm package.

Read More

Versions

  • 1.0.0 - 1.0.4
    • Development
    • Added Main Feature Set
    • Added Save Feature
  • 1.0.5
    • Added tags
    • Centered Text
    • Added Accent Color
    • Updated Read Me
    • Bug Fixes
  • 1.0.6
    • Updated Read Me File
    • Minor Style Updates
    • Changed Font to Poppins
  • 1.0.7 (In Development)
    • Adding Particals with Partical JS
    • Added Multiple Themes

License

MIT © maks112v

Package Sidebar

Install

npm i night-night

Weekly Downloads

5

Version

1.0.6

License

MIT

Unpacked Size

37 kB

Total Files

8

Last publish

Collaborators

  • maks112v