MUEEE Custom Component Library

A customized Material-UI component library with enhanced features, custom themes, and reusable components.

Features

• Enhanced MUI components with additional functionality
• Custom theme support
• TypeScript support
• Storybook documentation
• Comprehensive test coverage
• Easy integration with React applications

Installation

npm install mueee-custom-lib

Usage

import { ThemeProvider } from '@mui/material/styles';
import { EnhancedButton, defaultTheme } from 'mueee-custom-lib';

function App() {
  return (
    <ThemeProvider theme={defaultTheme}>
      <EnhancedButton 
        variant="contained" 
        loading={false}
        success={false}
      >
        Click Me
      </EnhancedButton>
    </ThemeProvider>
  );
}

Components

EnhancedButton

An enhanced version of MUI's Button component with additional features:

• Loading state with spinner
• Success state with custom text
• All standard MUI Button props supported

<EnhancedButton
  variant="contained"
  loading={true}
  success={false}
  successText="Done!"
  onClick={() => console.log('clicked')}
>
  Submit
</EnhancedButton>

EnhancedCombobox

An enhanced version of MUI's Autocomplete and Textfield components with additional features:

<EnhancedCombobox
  variant="contained"
  success={false}
  successText="Done!"
  onChange={() => console.log('changed')}
  options = {['Option 1', 'Option 2', 'Option 3']}
>
  Select A Value
</EnhancedCombobox>

Development

Setup

1. Clone the repository
2. Install dependencies:

   npm install

Running Storybook

npm run storybook

Running Tests

# Run tests once
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage
npm run test:coverage

Building

npm run build

Versioning and Publishing

# this updates version in pacakage.json
# this DOES NOT makes a commit with the v0.0.2 comment
# this DOES NOT creates a Git tag starting with v, v0.0.2
npm version 0.0.2


# this creates the tag and pushes the tag to the remote repository
git tag v0.0.2
git push --tags

Publishing

1. Update version in package.json
2. Build the library:

   npm run build

3. Publish to npm:

   npm publish

Contributing

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

MIT

Support

For support, please open an issue in the repository.