creative-connections/aurelia-bodylight-plugin

View on GitHub
docs/developersguide.md

Summary

Maintainability
Test Coverage
## Developer's guide

To add a new webcomponent:
1. create component definition in `src/components`, either only HTML or HTML and JS
2. register component as webcomponent in `src/webcomponents.js` adding a row
```javascript
export function configure(aurelia) {
aurelia.use
...
//use this routine to register HTML only component as web component
.globalResources(PLATFORM.moduleName('components/mycomponent.html'))
//use this routine to register component (JS and HTML) as web component
.globalResources(PLATFORM.moduleName('components/mycomponent'))
...
```
3. build the bodylight.bundle.js using `au build`
4. add documentation section about new component into User's guide