open-index/open-npm huggingface dataset:
npm package: @mechanicalrock/figma-tokens-to-mui
Description: A transformer which sits between FigmaToken JSON output and MUI's theme
Author: Mechanical Rock
Latest version: 1.1.0

# figma-tokens-to-mui

A transformer which sits between FigmaToken JSON output and MUI's theme

---

## Local testing

```bash
$ ts-node tests/index.ts
```

## External Consumption

### Debug

.env
```bash
# (Optional) This is a boolean value which will output the transformed tokens to the console. This is useful for debugging.
FIGMA_THEME_DEBUG=true #
```

### Colours

Merge the output of the transformer with your MUI theme.

```js
// src/styles/themeConfig/colourPalette.ts
...
export const colourPalette = getPaletteProps(
  tokens,
  "global",
  baseColours
);
```

### Typography

Merge the output of the transformer with your MUI theme.

```js
// src/styles/themeConfig/typography.ts
...
export const typography: TypographyOptions = getTypographyProps(
  tokens,
  "global",
  baseTypography
);
```