Code Monkey home page Code Monkey logo

material-foundation's Introduction

Material Foundation

Material Foundation

Material Design version of Foundation for Sites by Zurb

Supported Foundation Version: 6.2.3

Demo: http://eucalyptuss.github.io/material-foundation/

Requirements

You'll need to have the following items installed before continuing.

  • Node.js: Use the installer provided on the NodeJS website.
  • Grunt: Run [sudo] npm install -g grunt-cli
  • Bower: Run [sudo] npm install -g bower

Quickstart

git clone https://github.com/eucalyptuss/material-foundation.git
cd material-foundation
npm install && bower install

While you're working on your project, run:

grunt watch

to make grunt watch and compile all your CSS and javascript, or run:

grunt

to compile files manually

Directory Structure

scss/

  • material-foundation.scss: Main CSS file
  • demo.scss: CSS for the preview purposes, don't mind it
  • scss/_global.scss: global settings
  • scss/_foundation.scss: the rest of original Foundation's code is imported here

How to use Material Foundation

  1. Import material-foundation.scss to your stylesheet (the same way it is done in the demo file).
  2. Set your primary and accent colors using the $foundation-palette variable and override any other variables if necessary. Include the variables before the material-foundation stylesheet.
  3. Include material-foundation.js before your closing </body> tag.

And that's it!

How to use Material Foundation with an existing Foundation project

To use Material Foundation with an existing Foundation project you can simply replace the Foundation with Material Foundation and everything should work as expected.

However, due to the differences between Foundation and Material Design Guidelines, some of the Material Foundation components are not based on the original Foundation's markup. To use them in your project you have to use the Material Foundation specific classes, e.g. floating-action-button to use a Floating Action Button.

To view how the original Foundation components behave with the Material Foundation styles check the Kitchen Sink on the Material Foundation website.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.