@optus-asimov/react-material-ui-components-lib

React Components library on Material UI, customised for Asimov Optus

Install

npm i @optus-asimov/react-material-ui-components-lib

Peer Dependencies

This module requires react, react-router-dom, @material-ui/core and @material-ui/icons as mandatory dependencies installed in the project which is installing this module.

Alternatively, all these required dependencies can be installed with following command.

npm i @optus-asimov/react-material-ui-components-lib react react-router-dom @material-ui/core @material-ui/icons

Sample Usage

import React from "react";
import {
  PrimaryButton,
  MessageBox,
  theme,
} from "@optus-asimov/react-material-ui-components-lib";
import { ThemeProvider } from "@material-ui/styles";

const App = () => {
  return (
    <ThemeProvider theme={theme}>
      <div>
        <PrimaryButton>Primary</PrimaryButton>
        <MessageBox type="success">Success</MessageBox>
      </div>
    </ThemeProvider>
  );
};
export default App;

Stash Repository

STASH LINK

Components

This project deals with UI Components only. Components added so far:

• Buttons - Variety of buttons styled for Optus
• Loading Indicator (Loader)
• MessageBox - for showing custom messages
• Typography
• Box
• Card
• Confirmation Dialog
• Snackbar (toast)
• Breadcrumb

Theme

This package also exports the theme configuration, to be used with ThemeProvider.

License

MIT © ASIMOV