A wrapper around document.registerElement()
to define a custom-element with workarounds for gaps in the Gecko platform, plus some convenience methods.
$ bower install gaia-components/gaia-component
var MyComponent = component.register('my-component', {
// extend component from the given prototype
extends: HTMLButtonElement.prototype,
created: function() {
// Creates a shadow-root and
// puts your template in it
this.setupShadowRoot();
},
attributeChanged: function() {},
attached: function() {},
detached: function() {},
template: `
<button>I live in shadow-dom</button>
<style>
button { color: red }
</style>
`,
// Some CSS doesn't work
// in shadow-dom stylesheets,
// this CSS gets put in the <head>
globalCss: `
@keyframes my-animation { ... }
@font-face { ... }
`,
// Property descriptors that get defined
// on the prototype and get called
// when matching attributes change
attrs: {
customAttr: {
get: function() { return this._customAttr; },
set: function(value) { this._customAttr = value; }
}
}
});
var myComponent = new MyComponent();
myComponent.setAttribute('custom-attr', 'foo');
myComponent.customAttr; //=> 'foo';
Components can extend other components:
var MyComponent = component.register('my-component', {
// extend component from the given prototype
extends: HTMLButtonElement.prototype,
...
});
var YourComponent = component.register('your-component', {
// extend component from the given prototype
extends: MyComponent.prototype,
...
});
If the property extensible: false
is set the registered component
cannot be extended:
var MyComponent = component.register('my-component', {
// extend component from the given prototype
extends: HTMLButtonElement.prototype,
extensible: false,
...
});
Extensible components come with a little bit of overhead. For instance, they store a copy of the template string that derived components will use to properly inherit the styles. With the extensible flag set to false components won't store the template string and some memory will be saved. This is an optimization for production systems and large component hierarchies. Registed components are extensible by default.
- Ensure Firefox Nightly is installed on your machine.
$ npm install
$ npm test
If your would like tests to run on file change use:
$ npm run test-dev
Run lint check with command:
$ npm run lint