@mui-kit/components

Components

Shared Material-UI based Component Library for React Apps

Demo | Documentation | Issues

Install

Make sure you have the latest version of node and npm installed.

npm install --save @mui-kit/components

Components requires react, react-dom, @material-ui/core and @material-ui/icons as peer dependencies.

npm install --save react react-dom @material-ui/core @material-ui/icons

Usage

import React from 'react'
import { Select } from '@mui-kit/components'

const options = [
  { value: 'chocolate', label: 'Chocolate' },
  { value: 'strawberry', label: 'Strawberry' },
  { value: 'vanilla', label: 'Vanilla' },
]

const Example = () => <Select options={options} />

Contributing

There are plenty of opportunities to get involved. Pick an outstanding task, let us know what you are working on and fire away with any questions.

The package is made up of 2 main folders:

• /src contains the React components
• /demo is our demo website

To setup and run a local copy:

1. Clone this repo with git clone https://gitlab.com/mui-kit/components.git
2. Run npm install in the root folder
3. Run npm install in the demo folder
4. In separate terminal windows, run npm start in the root and demo folders.

You should now be up and running with live browser reloading of the demo website while you work on the Components in the /src folder.

When you're done working on your changes, submit a PR with the details and include a screenshot if you've changed anything visually.