A plugin capable of transforming Aurelia components into standards-compliant Web Components.
Switch branches/tags
Nothing to show
Clone or download

README.md

web-components

npm Version ZenHub Join the chat at https://gitter.im/aurelia/discuss

This library is part of the Aurelia platform and contains a plugin capable of transforming Aurelia components into standards-compliant Web Components.

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions, please join our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

Platform Support

This library can be used in the browser.

Usage

Here's an example configuration for main.js to show how to convert all global custom elements into web components:

import {ComponentRegistry} from 'aurelia-web-components';

export function configure(aurelia) {
   aurelia.use
     .standardConfiguration()
     .developmentLogging()
     .globalResources('resources/my-component');

   aurelia.start().then(() => {
     let registry = aurelia.container.get(ComponentRegistry);

     //The following line takes all global resource custom elements and registers them as web components.
     //Once the element is registered, in-page elements will begin rendering.
     registry.registerAllGlobalElements();
   });
 }

Note: This plugin requires that your browser have native support for the CustomElements v1 spec or that you have configured a v1 spec-compliant polyfill prior to calling registry methods.

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