https://github.com/lufzle/muito

A collection of React components based on Material-UI.
https://github.com/lufzle/muito

components javascript material-ui react ui

Last synced: 13 days ago
JSON representation

A collection of React components based on Material-UI.

• Host: GitHub
• URL: https://github.com/lufzle/muito
• Owner: lufzle
• License: mit
• Created: 2019-06-01T21:53:27.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-01T22:49:42.000Z (almost 6 years ago)
• Last Synced: 2025-02-16T01:44:46.942Z (2 months ago)
• Topics: components, javascript, material-ui, react, ui
• Language: TypeScript
• Homepage: https://luisfarzati.github.io/muito
• Size: 1.21 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/github/license/luisfarzati/muito.svg?color=blue)](https://github.com/luisfarzati/muito/blob/master/LICENSE)

[![CircleCI](https://img.shields.io/circleci/build/github/luisfarzati/muito/master.svg)](https://circleci.com/gh/luisfarzati/muito)

[![Storybook](https://cdn.jsdelivr.net/gh/storybooks/brand@master/badge/badge-storybook.svg)](https://luisfarzati.github.io/muito/?path=/story/avatar--with-valid-src)

# Muito 

A collection of React components based on the awesome library Material-UI.

## Why Muito

After trying out a few component libraries, I decided to go with MUI. However, it lacks a few tricks that I've seen in other libs. Muito intends to fill that gap by implementing those features and, why not, maybe more.

## Philosophy

Muito provides additional features via new components or by extending MUI components. When it comes to the latter, it will always respect the component interface. You should be able to replace MUI with Muito and everything should still work and look exactly as before.

## Components

See [the storybook](https://luisfarzati.github.io/muito/?path=/story/avatar--with-valid-src).

## Avatar

#### Fallback for broken image links

When `src` cannot be loaded or is an invalid link, Avatar will fallback to its empty form.

```jsx

```

#### Initials

When `subject` with a `name` is provided, Avatar will render the name initials if `src` is broken or not provided.

```jsx

```

By default, the background color will be deterministically generated from the subject's name. This can be overriden via CSS.

```css

.fixed-color {

  background-color: black;

}

```

```jsx

```

### Avatar Set

TODO

## Development

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Available Scripts

In the project directory, you can run:

#### `npm start`

Runs the app in the development mode.


Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.


You will also see any lint errors in the console.

#### `npm test`

Launches the test runner in the interactive watch mode.


See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

#### `npm run build`

Builds the app for production to the `build` folder.


It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.


Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

#### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

### Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).