Giter Club home page Giter Club logo

react-dark's Introduction

React Dark

Important

This Module will remember your last theme set and will save it for the future. So when a user starts up an application again it will set the last applied theme automatically.

Prerequisites

  • NodeJS (check for it's installation on terminal using npm -v)

Steps to set the environment

  1. Clone the repository
 git clone https://github.com/Awesome-React-Modules/React-Dark.git
  1. Install Dependencies
npm install --save react-dark

Usage

Add dark mode feature to your React App in just three simple steps.

Open your main CSS file and follow the steps mentioned.

  1. Declare root variables (as per your choice). This will be displayed when dark mode is not enabled.

Note: Use these variables only for specifying values to your CSS properties.

For example :-

:root {
	--bg-color: #fff;
	--heading-color: #000;
}

and use it on any class. For example :-

.main_heading{
	color: var(--heading-color)
}
  1. Now decalre the variables which you would like to change when it is changed to dark mode.

[data-theme="dark"] {
	--bg-color: #000;
	--heading-color: #fff;
}
  1. And now your are good to go. Just import the module and use it inside your React Application.

Working

import  Darktheme  from  "react-dark";

JS

import  React, { Component } from  'react';
import  Darktheme  from  "react-dark";

export  default  class  Example  extends  Component {
	render() {
		return (
			<div>
				<Darktheme  />
			</div>
		)
	}
}
export  default  Example;

Playground

Find Codepen Implementation of the module here

Example

JS

import React, { Component } from 'react';
import Darktheme from "react-dark";

export default class Example extends Component {
  render() {
    return (
      <div className="App">
        <Darktheme/>
	//This will set the Background color to dark
      </div>    
      )
  }
}

export default Example;

Development and Testing

  1. Set-up the React-Dark module by dowloading its dependencies, using npm install command.
  2. Build the module using npm run build
  3. Link the module for testing using npm link command.
  4. Change your directory to test-server directory, using cd test-server
  5. Install the dependecies using npm install
  6. Now run npm link react-dark
  7. Congratulations! You have set-up the test server for react-dark. Now just run npm start from test-server directory to launch the test-server.
  8. You don't need to stop this server, the changes made in the module will be reflected automatically each time you build them using npm run build

Contributing

Please read CONTRIBUTING.md for information on how to contribute to React-Pincode.

Development Guidelines

  1. Write clean and readable code with proper formatting.
  2. Create a branch and push your code in the branch.
  3. Please follow PR template to create PR.
  4. Please read our Code of Conduct .

Owner

Apoorv Taneja

Mentor

Apoorv Taneja Aditya Srivastava

Feel Free to ask your queries!!

Happy Coding ๐Ÿš€ ๐Ÿš€

react-dark's People

Contributors

plxity avatar kuljeet-123 avatar aman-codes avatar adityasrivast avatar dependabot[bot] avatar shreyakapoor08 avatar

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.