aurelia-material-design-lite

A Material Design Lite plugin for Aurelia.

Status: abandoned.

Getting Started

1. Install the plugin (docs):

jspm install aurelia-material-design-lite

2. Import the plugin (docs):

// main.js
export function configure(aurelia) {
  aurelia.use
    .standardConfiguration()
    .developmentLogging()
    .plugin('aurelia-material-design-lite'); // add this line

  aurelia.start().then(() => aurelia.setRoot());
}

3. Include Material Design Lite using one of the methods below:

• from CDN (docs):
  Version 1.2.0 is just as example.

  <!-- index.html -->
  <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
  <link rel="stylesheet" href="https://code.getmdl.io/1.2.0/material.indigo-pink.min.css">
  <script defer src="https://code.getmdl.io/1.2.0/material.min.js"></script>

• using Aurelia (docs)

  <!-- app.html -->
  <require from="material-design-lite/material.css"></require>
  <require from="material-design-lite/material.js"></require>

  <!-- index.html -->
  <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">

Using the plugin

Add one mdl attribute to elements that have a mdl-js-component class (mdl-js-button, mdl-js-layout, mdl-js-progress, etc.):

<button mdl class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--accent">
  Button
</button>

The mdl attribute is not required for elements that do not have a mdl-js-component class.

Building The Code

To build the code, follow these steps.

1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:

npm install

3. Ensure that Gulp is installed. If you need to install it, use the following command:

npm install -g gulp

4. To build the code, you can now run:

gulp build

5. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

6. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:

npm install -g karma-cli

2. Ensure that jspm is installed. If you need to install it, use the following commnand:

npm install -g jspm

3. Install the client-side dependencies with jspm:

jspm install

4. You can now run the tests with this command:

karma start