JSPM

Getting the plugin

Important: Make sure you run jspm version 0.16.15.

In your project install the plugin via jspm with the following command:

  $ jspm install aurelia-materialize-bridge

Make sure you also install Materialize. There are several options available. Not concerning forks, these are available:

npm

$ jspm install materialize-css

github

$ jspm install materialize=github:Dogfalo/materialize

Materialize >= 0.98.0

Add this override to package.json (as a child of the jspm property) if you're using the npm version:

"overrides": {
  "npm:materialize-css@0.98.0": {
    "main": "dist/js/materialize",
    "format": "global",
    "shim": {
      "dist/js/materialize": {
        "deps": [
          "jquery",
          "../css/materialize.css!"
        ]
      }
    }
  }
}

Add this override to package.json(as a child of the jspm property) if you're using the GitHub version:

"overrides": {
  "github:Dogfalo/materialize@0.98.0": {
    "main": "js/materialize",
    "format": "global",
    "shim": {
      "js/materialize": {
        "deps": [
          "jquery",
          "../css/materialize.css!"
        ]
      }
    },
    "dependencies": {
      "jquery": "jspm:jquery@*",
      "css": "jspm:css@*"
    }
  }
}

Configure your app

  1. Make sure you use manual bootstrapping. In order to do so open your index.html and locate the element with the attribute aurelia-app:

     <body aurelia-app="main">
 ...

    For Material Design icons include this in your index.html head section:

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

  2. Update main.js in your src folder with following content:

    export function configure(aurelia) {
 // These variables are only here to be able to distinguish between the two
 // installation options presented above.
 // Of course you can use the correct name directly in the import below.

 let materialize = 'materialize'; // ONLY when using the "github" option above
 let materialize = 'materialize-css'; // ONLY when using the "npm" option above

 return aurelia.loader.loadModule(materialize).then(() => {
   aurelia.use
     .standardConfiguration()
     .developmentLogging()
     // Install and configure the plugin
     .plugin('aurelia-materialize-bridge', bridge => bridge.useAll() );

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

    Please make sure that you use only one of the imports shown above.

    Note: You could just import 'materialize' into your app but since Materialize is not a direct dependency of this bridge anymore, it may get loaded asynchronously. This may lead to Materialize being initialized after components are attached() which essentally applies Materialize twice.

    Note: The above shows how to use all available controls at once. If you choose to pick which you'd like to use, you can use single components like this:

    .plugin('aurelia-materialize-bridge', bridge => {
 bridge
   .useButton()
   .useCollapsible()
   .useModal()
   .useTabs();
});

    At the end of this page is a full list of currently available options.

You are done!

It is now possible to drop some custom-elements into your DOM. See the other pages on this website for detailed information on how to do this.

Now you might want to do our app developers tutorial, based on Aurelia Skeleton navigation. Before doing this, make sure you set up your environment appropriately.

As described above, here is a full list of currently available options:

aurelia.use.plugin('aurelia-materialize-bridge', bridge => {
  bridge
    .useAutoComplete()
    .useBadge()
    .useBreadcrumbs()
    .useBox()
    .useButton()
    .useCard()
    .useCarousel()
    .useCharacterCounter()
    .useCheckbox()
    .useChip()
    .useCollapsible()
    .useCollection()
    .useColors()
    .useDatePicker()
    .useDropdown()
    .useFab()
    .useFile()
    .useFooter()
    .useInput()
    .useModal()
    .useNavbar()
    .usePagination()
    .useParallax()
    .useProgress()
    .usePushpin()
    .useRadio()
    .useRange()
    .useScrollfire()
    .useScrollSpy()
    .useSelect()
    .useSidenav()
    .useSlider()
    .useSwitch()
    .useTabs()
    .useTooltip()
    .useTransitions()
    .useWaves()
    .useWell();
});
PreviousWebpackNextAurelia-CLI

Last updated