antd-gui
v1.0.4
Published
A React Hook for adding a dark / night mode to your site inspired by darkreader
Downloads
9
Maintainers
Readme
Getting Started
Install with yarn
yarn add antd-gui
Or you can
npm install antd-gui
Or inject the script at your page by jsdelivr CDN
<script src="https://cdn.jsdelivr.net/npm/antd-gui@latest/dist/index.min.js"></script>
🚀 Usage
You can import the darkmode as a react component.
import React from 'react';
import { useControls } from 'antd-gui';
export default () => {
const { name, aNumber } = useControls({ name: 'World', aNumber: 0 });
return (
<div>
Hey {name}, hello! {aNumber}
</div>
);
};
🔢 Coming Soon
- [x] 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
❤️ Contributors
Thanks goes to these people (emoji key):