mavin-ui v0.4.0

Mavin-UI

Repository containing reusable Mavin-UI React built on top of Material UI.

Usage

To use the library add, add the Mavin-ui package to your project by installing it:

• yarn add mavin-ui

Development

The library itself is located at ./src/components and playground is located at ./playground/src/App.js

• Run npm run i-all to install all the dependencies for the mono repo
• Run npm run build to create mavin-ui component library

You should have a ./dist folder with two bundled files in it, index.cs.js and index.esm.js

• Run the playground app npm run dev

This will build the library, watch for modifications, and run the Playground App at http://localhost:3000

Publishing package

• Run npm publish

If you have never publish a package to Gitlab NPM registry, please generate personal access token and use it as your password to be able to log in. Read more here: https://docs.gitlab.com/ee/user/packages/npm_registry/

Elements in lib:

Badge - https://material-ui.com/components/badges/#badge Button - https://material-ui.com/api/button/ ButtonGroup - https://material-ui.com/components/button-group/#button-group Card - https://material-ui.com/components/cards/#card CardActions - https://material-ui.com/api/card-actions/#cardactions-api CardContent - https://material-ui.com/api/card-content/#cardcontent-api CardHeader - https://material-ui.com/api/card-header/#cardheader-api CardMedia - https://material-ui.com/api/card-media/#cardmedia-api Checkbox - https://material-ui.com/api/checkbox/#main-content Chip - https://material-ui.com/api/chip/ CircularProgress - https://material-ui.com/api/circular-progress/#circularprogress-api ClickAwayListener - https://material-ui.com/api/click-away-listener/#clickawaylistener-api Collapse - https://material-ui.com/api/collapse/#collapse-api Fab - https://material-ui.com/api/fab/#fab-api MavinTheme - just theme provider with only children prop MenuItem - https://material-ui.com/api/menu-item/#menuitem-api Modal - https://material-ui.com/api/modal/ Paper - https://material-ui.com/api/paper/#paper-api Popper - https://material-ui.com/api/popper/ Radio - https://material-ui.com/api/radio/ Select - https://material-ui.com/api/select/ Switch - https://material-ui.com/api/switch/ TextField - https://material-ui.com/api/text-field/#textfield-api Typography - https://material-ui.com/api/typography/

Icons in lib:

ArrowDropDown Chat CheckCircle Close ContactSupport Delete Edit Email MoreVert Person Reply Send SentimentDissatisfied SentimentSatisfiedAlt SentimentVeryDissatisfied SentimentVerySatisfied Sort Star