English | ็ฎ€ไฝ“ไธญๆ–‡

React Darkreader

๐ŸŒ“ A React Hook for adding a dark / night mode to your site inspired by darkreader

Live Demo โœจ https://react-darkreader.vercel.app

Getting Started

Install with yarn

yarn add react-darkreader

Or you can

npm install react-darkreader

Or inject the script at your page by jsdelivr CDN

<script src="https://cdn.jsdelivr.net/npm/react-darkreader@latest/dist/index.min.js"></script>

๐Ÿš€ Usage

You can import the darkmode as a react component.

import React from 'react';
import Darkreader from 'react-darkreader';

export default () => <Darkreader />;

You can also create darkmode by the react hook useDarkreader

import React from 'react';
import { Switch, useDarkreader } from 'react-darkreader';

export default () => {
  const [isDark, { toggle }] = useDarkreader(false);

  return <Switch checked={isDark} onChange={toggle} />;
};

๐Ÿ“” API

Component

<Darkreader
  defaultDarken
  theme={/** Theme options **/}
  fixes={/** Contains fixes for the generated theme **/}
  onChange={isDark => {
    /** Callback for change **/
  }}
/>

Hook

const [isDark, { toggle, collectCSS }] = useDarkreader(defaultDarken, theme?, fixes?)

with a toggle button as ui.

<Switch checked={isDark} onChange={toggle} />

Result

Params

๐Ÿ”ข Coming Soon

• add the material design styling in switch
• followSystemColorScheme
• localstorge
• playground for editing the config online

๐Ÿ”จ Contribute

Install dependencies,

$ npm i

Start the dev server,

$ npm start

Build documentation,

$ npm run docs:build

Build library via father-build,

$ npm run build

๐Ÿฅ‡ Who is using

Ant Design Pro Components Light	Ant Design Pro Components Dark

More here โ†’ Welcome to submit.

โ?ค๏ธ? Contributors

Thanks goes to these people:

Please Feel free to enjoy and participate in open source!

โญ? Stargazers

Thanks for your star!

License

MIT