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

@mojule/dom-components

v0.2.2

Published

A way to turn nested components backed by your own templates into DOM nodes

Downloads

4

Readme

dom-components

npm install @mojule/dom-components

A way to turn nested components backed by your own templates into DOM nodes

HTML syntax

<!-- model as attributes -->
<m-box name="foo">
  <m-box>
    <!-- model as embedded JSON -->
    <m-model>{ "name": "bar" }</m-model>
    <p class="baz">Hello world</p>
  </m-box>
</m-box>

JSON syntax

[ "Box", { "name": "foo" },
  [ "Box", { "name": "bar" },
    [ "p", { "class": "baz" },
      "Hello world"
    ]
  ]
]

The custom elements will be mapped via supplied template functions with a model and any child nodes

Custom elements start with m- - the m- will be stripped and the remainder of the name will be converted to PascalCase, eg m-foo-bar refers to a template called FooBar

Attributes on m- elements will become properties on a model passed to the template function and have their names converted from kebab-case to camelCase, eg <m-foo bar-baz="qux"> will call provided template Foo with the model { "barBaz": "qux" }

For complex models, embed the JSON for the model directly inside an immediate child node with the tag <m-model>, eg <m-foo><m-model>{ "bar": "baz" }</m-model></m-foo>

The JSON syntax is [ name[, model ], ...children ], where name is a template or tag name, model is the template model or attribute map for the DOM element, and children is 0 or more nodes in the same format

Text nodes are just strings

Some special JSON nodes are also supported:

[ "documentFragment",
  [ "comment", "foo" ],
  "text node is just a string"
]
const DomComponents = require( '@mojule/dom-components' )

const templates = {
  Box: ( model, ...childNodes ) => {
    const box = document.createElement( 'div' )
    box.classList.add( 'box' )
    box.setAttribute( name, model.name )

    childNodes.forEach( child => box.appendChild( child ) )

    return box
  }
}

// document can be window.document, a JSDOM document etc
const toDom = DomComponents( document, templates )

// call toDom with either a DOM node following the convention above or JSON
document.body.appendChild( toDom( componentNode ) )
document.body.appendChild( toDom( json ) )
<div class="box" name="foo">
  <div class="box" name="bar">
    <p class="baz">Hello World</p>
  </div>
</div>