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

@reduct/assembler

v2.0.4

Published

Parses a DOM Node for tags and executes the matching constructor on each element.

Downloads

23

Readme

@reduct/assembler

Build Status Dependency Status devDependency Status Code Climate Test Coverage

Parses a DOM Node for tags and executes the matching constructor on each element. This module embraces the practice of a 'Single Point of Entry'-Application(SPE).

Why?

Using a single point of entry reduces code and promotes maintainability. Instead of writing the following accross all of your sites/apps components:

// An example using jQuery/Zepto.
$('.myAwesomeApp').each(function(index, node) {
	new AwesomeApp(node);
});

... you will just create an assembler, which does all the initializing logic for you. It also reduces the number of operations in the DOM, which is great for performance since DOM operations are generally slow. Last but not least, your apps/components are free of selectors, you don't need to adjust your component if another project forbids the use of classes or a certain data-* attribute as a JS selector.

TL;DR: Use an assembler, to reduce duplicate code, enhance performance and reduce the dependence of selectors in your JS.

Install

With npm, use the familiar syntax e.g.:

npm install @reduct/assembler --save

once the Assembler package is installed, just require it in the main application file.

var assembler = require('@reduct/assembler');

This package also supports AMD/RequireJS. Aren't using AMD or CommonJS? Access the assembler via the following global:

var assembler = window.reduct.assembler;

Configuration

In the main application file, create a new instance of the Constructor e.g.:

import assembler from '@reduct/assembler';
import MyComponent from 'MyComponent';
import YetAnotherComponent from 'YetAnotherComponent';

let app = assembler();

app.register(MyComponent);
app.register(YetAnotherComponent)

app.run();

In your HTML:

<div data-component="MyComponent"></div>
<div data-component="YetAnotherComponent"></div>

API

Factory

The factory creates a new instance of the assembler, called app.

import assembler from 'assembler';

let app = assembler();

register(Class[, name])

Registers a given component. You can define an optional name in order to overwrite the component's name.

import MyComponent from 'my-component';
import AnotherComponent from 'another-component';

app.register(MyComponent);
app.register(AnotherComponent, 'FooComponent');

Your HTML would look like

<div data-component="MyComponent"></div>
<div data-component="FooComponent"></div>

registerAll(classMap)

Registers a bunch of components at once.

import MyComponent from 'my-component';
import AnotherComponent from 'another-component';

app.registerAll({
    MyComponent: MyComponent,
    FooComponent: AnotherComponent
});

The corresponding HTML:

<div data-component="MyComponent"></div>
<div data-component="FooComponent"></div>

You can shorten this statement if you're using ES2015 and do not want to rename the component classes:

import MyComponent from 'my-component';
import AnotherComponent from 'another-component';

app.registerAll({MyComponent, AnotherComponent});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Regarding the commit messages, please use a prefix listed at Inkdpixels/commit-analyzer so semantic-release can do it's ob properly.

License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.