FAQ

Have a question that's not answered here? Submit an issue on Github.

What licence is it under?

Mache is under the MPL 2.0.

How do I install it?

On each component page, there are examples of the HTML markup to use, and a CSS file that you can either copy and paste or import into your own project. Some components also have "recommended Javascript", which may be nessecary to use that component, depending on how you want to use it.

How big is it?

What browsers does it work on?

Mache works on most modern browsers.

Do I have to give credit if I use it?

If you are building a personal project, you don't have to give credit, although it is encouraged. It is strongly encouraged that you give credit in a commercial product, whether that be on a credit or info page, or in your footer.

What is material design?

Material design is a design language created by Google to help unify the user experience, while providing a way to deliver a unique UI, all with principles that help make up a good design.

Hasn't Google already made a material design library for the web?

Yes, however this library is designed to replicate the exact design principles and components at the expense of code understandability and file size.

Mache is different, as it is designed to provide the basic material components, while still being completely readable, and most importantly, editable. With Mache, if you don't like a particular part of the design you get, you can simply edit it.

How can I use material theming with this?

Google has recently introduced "material theming", which essentially allows you to redesign the material components to better fit your brand language. If you understand what this means, and you have had a look at the theming examples in the material docs, you can use CSS to alter the elements in Mache to theme it how you want.

I found a problem, what can I do?

If you've found a bug or problem with the library, you can let me know on Github by making a new issue.

How can I request a new feature?

If you want a feature added to Mache, like a particular component state that isn't included by default, and you think more people will benefit from having it instead of just coding it in yourself, then you can submit a feature request on Github by making a new issue.

Does it use Javascript?

While no components in Mache require javascript, some components like the navigation drawer or the bottom sheet have "recommended Javascript". This is because, depending on how you implement these components, a class needs to be toggled in order to open/close the components.