Getting started

Installation

Prerequisites

• Node.js version 18 or higher.
• A package manager: e.g. npm, pnpm, ...

npm

$ npm add @ogs-gmbh/mui-theme

pnpm

$ pnpm add @ogs-gmbh/mui-theme

yarn

$ yarn add @ogs-gmbh/mui-theme

bun

$ bun add @ogs-gmbh/mui-theme

Usage

mui-theme exports dark, light and general theme variants, that can get applied to the ThemeProvider Component. Please refer to our reference for getting a deeper understanding. Here's an example using theme:

example-component.tsx

import { ThemeProvider } from "@mui/material/styles";
import { theme } from "@ogs-gmbh/mui-theme";

function Example() {
  return <ThemeProvider theme={theme}>Content goes here ...</ThemeProvider>;
}