RMWC - React Material Web Components
A React (15 / 16) wrapper for the official Material Design (Web) Components v0.41.0 https://jamesmfriedman.github.io/rmwc/
Features:
- Uses Google's official material-components-web library
- Includes Addon components for ones missing from the official spec
- Works in any version of React from 15.5.x to 16.5.x
- First class Typescript (Beta) and Flow Support
- Server side rendering support
- Individually packaged and released components
Recent updates
See whats new in 4.0.0
View all release notes
View the changelog for detailed updates: https://github.com/jamesmfriedman/rmwc/blob/master/CHANGELOG.md
Goals
- To create the thinnest, lightest, and spec compliant wrapper around Google Material Design Components for the Web https://material.io/components/web/
- To utilize the Foundation javascript classes and expose their api for consumption
- To be as unobtrusive and sensible as possible.
- To fill the gaps in material-components-web with custom React community driven components.
Doesn't Google have their own React Wrapper?
Yes, and here are the differences.
- RMWC is feature complete! It contains all of the components in the MDC catalog.
- RMWC Includes Addon components for ones missing from the official spec
- RMWC Works in any version of React from 15.5.x to 16.5.x
- RMWC includes first class Typescript and Flow Support
- RMWC has tested server side rendering support
- RMWC favors deprecations over breaking changes whenever possible
- RMWC has interactive polished documentation
- RMWC is about 8 months older than Google's.
The MDC team has been nothing but collaborative and kind, even in pursuing their own React wrapper. Both libraries individually package components, so you can use this one, that one, or a mix of both if you want to. There are multiple production apps running RMWC, so this library will continue to exist and be improved. Hopefully in the future there can be a convergence point, but in the meantime you can weigh both libraries on their own merits. https://github.com/material-components/material-components-web-react
Installation
npm i rmwc --save
oryarn add rmwc
Additional information is available in the Installation Guide
Usage
Read the docs on how to Usage
Why?
Read the docs on Methodology
About Breaking Changes
Read the docs on Methodology
To run the tests
- On MacOS Sierra and higher, install watchman to fix a filesystem issue with
Jest.
brew install watchman
npm test
To run the docs / contribute
git clone https://github.com/jamesmfriedman/rmwc.git
cd rmwc
npm install
npm start
Contributions
This project exists thanks to all the people who contribute. [Contribute].
Backers
Thank you to all our backers!
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]