@cmckenna/ed-component-library

ed-component-library

## About this repo

• This repo was built with React 18 and Material UI v5
• The components are built on top of mui with theme overrides and logical enhancements

Peer Dependencies

{
  "react": "^18.2.0",
  "react-dom": "^18.2.0",
  "@emotion/react": "^11.11.3",
  "@emotion/styled": "^11.11.0",
  "@mui/x-date-pickers": "^6.19.6",
  "@mui/material": "^5.15.11"
}

Dependencies

{
  "@emotion/react": "^11.11.3",
  "@emotion/styled": "^11.11.0",
  "@mui/x-date-pickers": "^6.19.6",
  "@mui/material": "^5.15.11",
  "classnames": "^2.5.1",
  "dayjs": "^1.11.10",
  "lodash.debounce": "^4.0.8",
  "lodash.isequal": "^4.5.0",
  "notistack": "^3.0.1",
  "react-number-format": "^5.3.3",
  "use-lilius": "^2.0.4"
}

• You may notice that some dependencies are also peerDependencies
• This is because I want to install these packages for you when you install the repo
• They are also listed as peerDependencies because I want to throw an error if you are using a different version
• If you absolutely need a different version than what is listed as a peer depdency than you will have to perform a peer depdency resolution or update the component library itself
• To mitigate this, the component library has been built with the latest versions at the time of writing (March 2024)
• TLDR
  • If you wish to install any peerDependencies separate from the installation of this repo, make sure you are using the same versions
  • otherwise, you may encounter unexpected behaviour

## Getting Started

• Install the repo

npm i @cmckenna/ed-component-library

• Wrap your app in the ThemeWrapper and the SnackbarProvider
• Import the css file
  • the css file will import the required google fonts and some basic styles

import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';

import { ThemeWrapper, SnackbarProvider } from "@cmckenna/ed-component-library";
import "@cmckenna/ed-component-library/dist/index.css"; // <-- important to load css for fonts

const root = ReactDOM.createRoot(
  document.getElementById('root') as HTMLElement
);
root.render(
  <ThemeWrapper>
    <SnackbarProvider>
      <App />
    </SnackbarProvider>
  </ThemeWrapper>
);

## Documentation - For full documentation please check out the Storybook instance deployed on github pages - [https://cmcken22.github.io/ed-component-library](https://cmcken22.github.io/ed-component-library)