Skip to content

Repository files navigation

MUI Kit

A shared MUI-based UI toolkit. It provides a configurable theme plus a set of ready-made form fields, components, and hooks, so admin projects share one consistent look and set of building blocks.

import {
  createMuiKitTheme,
  FieldText,
  SeverityPill,
  SubmitButton,
  Toaster,
  usePopover,
} from '@m10c/mui-kit';

Theme

The theme is built in layers, each one overriding the one before it:

  1. MUI defaults — the standard MUI base theme.
  2. The kitcreateMuiKitTheme applies the shared m10c look (palette, shape, component defaults) on top of MUI.
  3. The project — each project takes the kit's theme and layers its own palette, typography, and component overrides on top, so it can diverge where needed while keeping the shared base.

In the simplest case a project just calls createMuiKitTheme and passes the result to MUI's ThemeProvider:

import { createMuiKitTheme } from '@m10c/mui-kit';
import { ThemeProvider } from '@mui/material/styles';

const theme = createMuiKitTheme({ primaryColor: 'indigo' });

<ThemeProvider theme={theme} defaultMode="light">
  <App />
</ThemeProvider>

createMuiKitTheme accepts overrides for the common cases:

createMuiKitTheme({
  primaryColor: 'blue',
  direction: 'rtl', // optional, defaults to ltr
  linkComponent: NextLink, // optional, wires a router link into MuiLink
  paletteOverrides: {
    // optional, deep-merged per color scheme
    light: { background: { default: '#fafafa' } },
    dark: { background: { default: '#101010' } },
  },
});

For anything beyond those options, layer a project theme on top with MUI's own createTheme. This is the third layer — the project keeps the kit's base and overrides only what it needs (here, typography and component styles):

import { createTheme } from '@mui/material/styles';
import { createMuiKitTheme } from '@m10c/mui-kit';

const base = createMuiKitTheme({ primaryColor: 'indigo' });

const theme = createTheme(base, {
  typography: { h1: { fontFamily: "'Plus Jakarta Sans', sans-serif" } },
});

theme.components = projectComponentOverrides; // project-specific MUI overrides

Components, form fields, and hooks

Components are standard MUI-styled React components and take their own props.

Form fields are built for react-typed-form — give each one a form field via its field prop, and it handles value/validation wiring:

import { FieldText, SubmitButton } from '@m10c/mui-kit';

<FieldText field={form.getField('name')} label="Name" />
<SubmitButton form={form}>Save</SubmitButton>

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages