npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fxos-component

v1.0.3

Published

A wrapper around `document.registerElement()` to define a custom-element with workarounds for gaps in the Gecko platform, plus some convenience methods.

Downloads

13

Readme

fxos-component

A wrapper around document.registerElement() to define a custom-element with workarounds for gaps in the Gecko platform, plus some convenience methods.

Installation

$ npm install fxos-component

Usage

var MyComponent = fxosComponent.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() {

    // Localizes shadow DOM of your
    // component and adds an observer for
    // when localization changes
    this.setupShadowL10n();
  },
  detached: function() {},

  // You can override this function and
  // specify how the shadow DOM of your
  // component should be localized.
  localizeShadow: function(shadowRoot) {},

  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';

Component Extension

Components can extend other components:

var MyComponent = fxosComponent.register('my-component', {
  // extend component from the given prototype
  extends: HTMLButtonElement.prototype,
  ...
});

var YourComponent = fxosComponent.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 = fxosComponent.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.

Tests

If you would like to run both unit and lint tests:

  1. Ensure Firefox Nightly is installed on your machine.
  2. $ npm install
  3. $ npm test

If your would like unit tests to run on file change use:

$ npm run test-unit-dev

Lint check

Run lint check with command:

$ npm run test-lint