Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 4.59 KB

README.md

File metadata and controls

90 lines (62 loc) · 4.59 KB
Raw

Material-UI

![Gitter](https://badges.gitter.im/Join Chat.svg)

Material-UI is a CSS framework and a set of React components that implement Google's Material Design specification.

Check out our documentation site for live examples. It's still a work in progress, but hopefully you can see where we're headed.

Prerequisites

We recommend that you get started with the React Library before diving into material-ui for a better understanding. Should you choose to skip this, don't worry, we'll explain relevant React concepts as they come along.

Installation

Material-UI is available as an npm package.

npm install material-ui

Use browserify and reactify for dependency management and JSX transformation. The CSS framework is written in Less, so you'll need to compile that as well. For Sass users, material-ui-sass contains the .scss version of the Less framework. People working with Stylus can use material-ui-stylus to import the proper .styl version of the files.

React-Tap-Event-Plugin

Some components use react-tap-event-plugin to listen for touch events. This dependency is temporary and will go away once react v1.0 is released. Until then, be sure to inject this plugin at the start of your app.

var injectTapEventPlugin = require("react-tap-event-plugin");

//Needed for onTouchTap
//Can go away when react 1.0 release
//Check this repo:
//https://github.com/zilverline/react-tap-event-plugin
injectTapEventPlugin();

Roboto Font

Be sure to include the Roboto font in your project. Here are some instructions on how to include it in your project.

Usage

Once material-ui is included in your project, you can use the components this way:

/** MyAwesomeReactComponent.jsx */

var React = require('react'),
  mui = require('material-ui'),
  RaisedButton = mui.RaisedButton;

var MyAwesomeReactComponent = React.createClass({

  render: function() {
    return (
      <RaisedButton label="Default" />
    );
  }

});

module.exports = MyAwesomeReactComponent;

Customization

The styles are separated into 2 less files:

  • src/less/scaffolding.less
  • src/less/components.less

This allows you to override any variables defined in custom-variables.less without having to modify material-ui source files directly. For example, your main.less file could look something like this:

@import "node_modules/material-ui/src/less/scaffolding.less";

//Define a custom less file to override any variables defined in scaffolding.less
@import "my-custom-overrides.less";

@import "node_modules/material-ui/src/less/components.less";

Examples

There are 2 projects that you can look at to help you get started. The first project can be found in the example folder. This is a basic project that shows how you can consume material-ui components in your own project.

The second project is the actual documentation site. This is a more complex project but will give examples of every component. Check out the docs folder for build instructions.

Contribute

Material-UI came about from our love of React and Google's Material Design. We're currently using it on a project at Call-Em-All and plan on adding to it and making it better. If you'd like to help, check out the docs folder. We'd greatly appreciate any contribution you make. :)

License

This project is licensed under the terms of the MIT license