0.3.0 • Published 1 year ago

mui-chameleon v0.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Warning: WIP This is not yet ready for production

MUI theme editor.

npm package npm downloads BundlePhobia Average time to resolve an issue

Github Action build Github Action test codecov

Buy me a coffee

Installation

MUI Chameleon is available as an npm package.

// with npm
npm install mui-chameleon

// with yarn
yarn add mui-chameleon

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react';
import ReactDOM from 'react-dom';

import ThemeProvider from 'mui-chameleon/ThemeProvider';
import SideBarEditor from 'mui-chameleon/SideBarEditor';

// import { ThemeProvider, SideBarEditor } from 'mui-chameleon';

function App() {
    const showEditor = true; // of course

    return (
        <ThemeProvider theme={yourInitialTheme}>
            <CssBaseline />

            {/* rest of the app */}

            {showEditor && <SideBarEditor />}
        </ThemeProvider>
    );
}

ReactDOM.render(<App />, document.querySelector('#app'));

Acknowledgments

  • Logo Design by Zara Magumyan. See her Dribbble for more awesome designs.
  • Some bundling Tools and scripts are used from MUI packages. This makes my job easier, faster and compatibility of this package better with MUI packages.

License

This project is licensed under the terms of the MIT license.