v0.33.4

Webpack

Getting the plugin

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

  $ npm install --save aurelia-materialize-bridge materialize-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:

    import {PLATFORM} from 'aurelia-pal';  
import 'materialize-css';

export function configure(aurelia) {
  aurelia.use
    .standardConfiguration()
    .developmentLogging()
    // Install and configure the plugin
    .plugin(PLATFORM.moduleName('aurelia-materialize-bridge'), b => b.useAll());

  aurelia.start();
  // delay setting the root until document is fully loaded
  // this will allow materialize framework fully load before bridge elements start attaching themselves
  new Promise(resolve => $(document).ready(() => resolve())).then(a => a.setRoot());
}

    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(PLATFORM.moduleName('aurelia-materialize-bridge'), bridge => {
 bridge
   .useButton()
   .useCollapsible()
   .useModal()
   .useTabs();
});

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

  3. Import css:

    <require from="materialize-css/dist/css/materialize.css"></require>

  4. Configure webpack:

    Change your ProvidePlugin configuration :

     new ProvidePlugin({
   '$': 'jquery',
   'jQuery': 'jquery',
   'window.jQuery': 'jquery',
 })

    This prevents jQuery from being added/initialized multiple times.

Look here for a working example. And the source for it.

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.

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

aurelia.use.plugin(PLATFORM.moduleName('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();
});
Previous2. InstallationNextJSPM

Last updated