---
url: /api/renderers/mui/src.md
---
[pantoken-root](../../../index.md) / mui

# mui

## Compatibility

Target: Material UI. Current format: `Concrete createTheme palettes (MUI 5, 6, 7, 9)`. Minimum host version: `5.0.0`. Tested through `9.4.0`. Newer releases require review.

[Full compatibility matrix](../../../../compatibility)

Experimental

`@pantoken/mui` — theme MUI (Material UI) with Instructure tokens.

[toMuiTheme](functions/toMuiTheme.md) maps any IR onto MUI theme options; [lightTheme](variables/lightTheme.md) and [darkTheme](variables/darkTheme.md)
are the ready-made `rebrand` options. Pass them to MUI's `createTheme`.

## Example

```tsx
import { createTheme, ThemeProvider } from "@mui/material/styles";
import { lightTheme } from "@pantoken/mui";
const theme = createTheme(lightTheme);
<ThemeProvider theme={theme}>...</ThemeProvider>;
```

## Interfaces

* [MuiPaletteColor](interfaces/MuiPaletteColor.md)
* [PantokenThemeOptions](interfaces/PantokenThemeOptions.md)

## Variables

* [lightTheme](variables/lightTheme.md)
* [darkTheme](variables/darkTheme.md)

## Functions

* [toMuiTheme](functions/toMuiTheme.md)

## References

### Mode

Re-exports [Mode](../../../packages/core/src/type-aliases/Mode.md)

***

### default

Renames and re-exports [lightTheme](variables/lightTheme.md)