README.md

MaterializeCSS

Materialize, a CSS Framework based on material design.
-- Browse the docs --


* These badges are for the original Materialize, not the AMD-compatible version

Note for AMD-compatible version

Notice that this is NOT the offical AMD-compatible version, and I won't keep updating it with latest commit (just stable release), so just use dist/js/materialize.js.

This modified version is tested and passed on curl.js, I'm not sure that it would compatible with other AMD module.

After required it at the first time, please do Waves.displayEffect() to show waves, like this:

require(['jquery']).next(['materialize'], function(Materialize){
    // add it when you required Materialize at the first time
    Waves.displayEffect();

    // do more things with Materialize here
});

For modified parts, see original issue here: Dogfalo#634 (comment)

Table of Contents

• Quickstart
• Documentation
• Supported Browsers
• Changelog
• Testing
• Contributing
• Copyright and license

Quickstart:

Read the getting started guide for more information on how to use materialize.

• Download the latest release of materialize directly from GitHub.
• Clone the repo: git clone https://github.com/ccloli/materialize.git, cd materialize then git checkout AMD-fix.
• Include the files via cdnjs. More here.
• Install with npm: npm install github:ccloli/materialize#AMD-fix (or replace AMD-fix to any modified version with -amd suffix like v0.100.1-amd).
• Install with Bower: bower install https://github.com/ccloli/materialize.git#AMD-fix (or replace AMD-fix to any modified version with -amd suffix like v0.100.1-amd).
• Install with Atmosphere: meteor add materialize:materialize. (Not sure if it works, try cloning the repo then try this StackOverflow)

Documentation

The documentation can be found at http://materializecss.com. To run the documentation locally on your machine, you need Node.js installed on your computer.

Running documentation locally

Run these commands to set up the documentation:

git clone https://github.com/ccloli/materialize
cd materialize
git checkout AMD-fix
npm install

Then run grunt monitor to compile the documentation. When it finishes, open a new browser window and navigate to localhost:8000. We use BrowserSync to display the documentation.

Documentation for previous releases

Previous releases and their documentation are available for download.

Supported Browsers:

Materialize is compatible with:

• Chrome 35+
• Firefox 31+
• Safari 7+
• Opera
• Edge
• IE 10+

Changelog

For changelogs, check out the Releases section of materialize or the CHANGELOG.md.

Testing

We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help, here's a starting guide on how to write tests in Jasmine.

Contributing

Check out the CONTRIBUTING document in the root of the repository to learn how you can contribute. You can also browse the help-wanted tag in our issue tracker to find things to do.

Copyright and license

Code copyright 2017 Materialize. Code released under the MIT license.