> **Note**: This is part of version 2 of FreeSewing.
> It is a work in progress, and not ready for prime-time yet
>
> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/).
FreeSewing is a free and open source library for made-to-measure sewing patterns
# @freesewing/mui-theme
A Material-UI theme for FreeSewing web UIs
freesewing
a library for made-to-measure sewing patterns
# @freesewing/mui-theme
This is a [Material UI](https://material-ui.com) theme that's used by the freesewing web sites.
## Install
```
npm i --save @freesewing/mui-theme
```
## Getting the theme
After installing [@freesewing/mui-theme](https://www.npmjs.com/package/@freesewing/mui-theme),
import it:
```js
import createTheme from "@freesewing/mui-theme";
```
The default export (`createTheme` in our example above) is a method that
calls [`createMuiTheme`](https://material-ui.com/customization/themes/#createmuitheme-options-theme) under the hood.
It takes a single argument, the theme name:
```
object createTheme(string themeName = "light")
```
If the name you pass it is `dark` you'll get the dark theme.
Anything else, and you'll get the light theme.
## Using the theme
To use this theme, you need to pass it as the `theme` prop to
[`muiThemeProvider`](https://material-ui.com/customization/themes/#muithemeprovider):
```js
// ... your app here
```
See [the Material-UI docs on themes](https://material-ui.com/customization/themes/) for more details.
## About FreeSewing
Where the world of makers and developers collide, that's where you'll find FreeSewing.
Our [core library](https://freesewing.dev/en/freesewing) is a *batteries-included* toolbox
for parametric design of sewing patterns. It's a modular system (check our list
of [plugins](https://freesewing.dev/en/plugins) and getting started is as simple as:
```bash
npm init freesewing-pattern
```
The [getting started] section on [freesewing.dev](https://freesewing.dev/) is a good
entrypoint to our documentation, but you'll find a lot more there, including
our [API documentation](https://freesewing.dev/en/freesewing/api),
as well as [examples](https://freesewing.dev/en/freesewing/examples),
and [best practices](https://freesewing.dev/en/do).
If you're a maker, checkout [freesewing.org](https://freesewing/) where you can generate
our sewing patterns adapted to your measurements.
## ♥️ Support FreeSewing: Become a patron ♥️
FreeSewing is an open source project run by a community,
and financially supported by our patrons.
If you feel what we do is worthwhile, you too
should [become a patron](https://freesewing.org/patrons/join).
## Links
- 💻 Makers website: [freesewing.org](https://freesewing.org)
- 💻 Developers website: [freesewing.dev](https://freesewing.org)
- 💬 Chat: [gitter.im/freesewing](https://gitter.im/freesewing/freesewing)
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)