freesewing/packages/mui-theme/README.md

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.

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 theme that's used by the freesewing web sites.

Install

npm i --save @freesewing/mui-theme

Getting the theme

After installing @freesewing/mui-theme, import it:

import createTheme from "@freesewing/mui-theme";

The default export (createTheme in our example above) is a method that calls createMuiTheme 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:

<MuiThemeProvider theme={createTheme(true)}>
  // ... your app here
</MuiThemeProvider>

See the Material-UI docs on themes for more details.

About FreeSewing

Where the world of makers and developers collide, that's where you'll find FreeSewing.

Our core library is a batteries-included toolbox for parametric design of sewing patterns. It's a modular system (check our list of plugins and getting started is as simple as:

npm init freesewing-pattern

The [getting started] section on freesewing.dev is a good entrypoint to our documentation, but you'll find a lot more there, including our API documentation, as well as examples, and best practices.

If you're a maker, checkout freesewing.org 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.

Links

• 💻 Makers website: freesewing.org
• 💻 Developers website: freesewing.dev
• 💬 Chat: gitter.im/freesewing
• 🐦 Twitter: @freesewing_org
• 📷 Instagram: @freesewing_org