JavaScript CSS Shell
Clone or download
Latest commit 04fdcbb Jul 5, 2018

README.md

react-md

React Material Design - React components built with sass

Build Status Join the chat at Slack Donate

react-md is a set of React components and sass files for implementing Google's Material Design. The Documentation Website can be used for viewing live examples, code samples, and general prop documentation.

Installation

$ npm install --save react react-dom react-md

There are also a few examples available within the examples folder to help get you started.

Customizing the theme

The application should define a primary and secondary color. The primary color should be chosen from one of the '-500' colors and the secondary should be one of the 'a-' colors.

The default color palette is defined as:

$md-primary-color: $md-indigo-500 !default;
$md-secondary-color: $md-pink-a-200 !default;

If you change these variables before the react-md-everything mixin is included, your entire application will be styled with your new theme.

@import '~react-md/src/scss/react-md';

$md-primary-color: $md-teal-500;
$md-secondary-color: $md-lime-a-400;

@include react-md-everything;

See the themes page on the documentation website. There is also a theme builder available to try mix and matching different colors.

Styling Links

There are currently no styles applied to links by default for two reasons:

  1. There aren't many guidelines for link styling in Material Design (or there weren't when I started this project)
  2. Most of the time, links will mostly be handled by the ListItem component with a react-router's Link component

If you would like some default link styles, you can copy/paste the following block to get some reasonable defaults.

// These are the styles that are applied to the documentation site.
// If you want **ALL** links to have these styles, you can of course change it to be applied
// to all <a> tags
.link {
  color: $md-primary-color;
  display: inline-block;
  text-decoration: none;
  transition: color $md-transition-time;

  &:visited {
    color: get-swatch($md-primary-color, 200, true);
  }

  &:hover {
    color: get-color('text', $md-light-theme);
    text-decoration: underline;
  }
}

Usage

Please see the list of examples for how you can get a project started off quickly with React and React MD.

UMD Usage

<!DOCTYPE html>
<html>
  <head>
    <link rel="stylesheet" href="https://unpkg.com/react-md@1.4.2/dist/react-md.deep_purple-pink.min.css">
    <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons|Roboto:400,500,700">
  </head>
  <body>
    <div id="app"></div>
    <script src="https://unpkg.com/react/dist/react-with-addons.min.js"></script>
    <script src="https://unpkg.com/react-dom/dist/react-dom.min.js"></script>
    <script src="https://unpkg.com/react-md@1.4.2/dist/react-md.min.js"></script>
    <script>
    var MyAwesomeComponent = React.createClass({
      render: function()  {
        return React.createElement(ReactMD.Button, { label: 'Hello, World!', flat: true });
      }
    });

    ReactDOM.render(React.createElement(MyAwesomeComponent), document.getElementById('app'));
    </script>
  </body>
</html>

Known Bugs/Works in Progress/Future Changes

  • Bottom sheets
  • Steppers
  • Eventually add Floating button transitions/morphing abilities. Ex: Speed Dial, Morph into toolbar/material/paper

Contributing

Please see the documentation site README for information about contributing using the documentation server. Otherwise, here is some information about only working within react-md.

Right now I am using the Ruby version of scss_lint to lint scss files. This means that you will need to have Ruby installed and the sass-lint gem.

$ gem install scss_lint

I have an issue (#274) open about switching over to the node port, but it hasn't really been worked on because I don't like the little amount of features that have been ported over so far.

Otherwise this should work on most systems with node >= 6.

Minimal Setup

mlaursen @ ~/code/react-md
$ yarn
$ yarn build   # build the es and lib folders for docs scripts
$ cd docs
mlaursen @ ~/code/react-md/docs
$ yarn
$ cp .env.example .env
$ cd ..
mlaursen @ ~/code/react-md
$ yarn dev

Development Scripts

lint

This will run both the lint:styles and lint:scripts commands.

lint:fix

This will attempt to automatically fix any eslint errors that can be fixed.

lint:styles

As stated above, this will lint all the scss files within the src/scss directory. Unfortunately, this requires the Ruby gems version of scss-lint to be installed to work because the node port isn't quite there yet for me. You can either remove this temporarily from the build process or:

$ gem install scss_lint

lint:scripts

This will run eslint over all the files in the src/js folder.

test

This command will run test:tsc followed by jest.

test:tsc

This will do a simple Typescript compliation test to make sure there aren't any syntax errors or invalid types. There should probably be a better testing system put in place.

test:watch

This will just run jest in watch mode.

test:docs

This will just run jest in the docs folder.

test:docs:watch

This will just run jest in watch mode in the docs folder.

test:all

This will run tests for Typescript definitions, the base react-md repo, and the docs folder.

tsd

This command will just copy all the Typescript definitions into the lib folder so that it can be used correctly by Typescript users.

css-bundles

This script makes 255 different scss files to be compiled for production use. This is automatically run before build.

dev

This will start up the documentation server in development mode as well as watching for changes within the base react-md library. Please look at the Getting Started for some preliminary setup required.

dev:minimal

This will start up the documentation server in development mode as well as watching for changes within the base react-md library. The only difference is that the docs:minimal command will be run instead of docs

docs

This will start up the documentation server in development mode. For some more information about this command, please see the documentation server scripts.

docs:minimal

This will start up the documentation server in development mode without rebuilding all the "databases" before startup.

prebuild

This command is automatically run before build. It will basically remove all the old artifacts and compiled files followed by linting the entire project.

build

This command will do the full build of react-md before a release. It runs almost all of the other scripts in a specified order so that the es, lib,dist folders are created and contain the correct files for release.

build:watch

This command will just build and watch changes for the CommonJS and ES6 modules distributables. This is just used behind the scenes for the dev command for hot reloads.

build:cjs

This command will build the CommonJS distributables for react-md.

build:cjs:watch

This command will build the CommonJS distributables for react-md and recompile when changes occur.

build:es

This command will build the ES6 modules distributables for react-md.

build🇪🇸watch

This command will build the ES6 modules distributables for react-md and recomple when changes occur.

build:umd

This command will create the UMD bundles for development and production use. It will also display the size of the production UMD bundle in pretty format bytes.