Imm-dom NPM | npm.io

Immediate-Mode DOM Tools

Lightweight tooling around DOM creation. Designed to be embedded piecewise in self-contained Web Components.

I love virtual DOM libraries like superfine, preact, and inferno. But not all creations need the efficient updating logic. Creations like self-sufficient Web Components, where every byte of superfluous logic is wasted.

The imm-dom library enables concise expression of DOM creation, while never setting innerHTML with uncontrolled content. Elements are created using createElement() or createElementNS(). Strings become Text nodes via createTextNode() or elem.append(). Attributes are set using elem.setAttribute(). DOM injection is protected against, in conjunction with caution and expertise, to provide tools for dynamic content.

Demo

See the mini demo and the demo's index.html source.

API

imm-dom provdes layers of DOM tools:

Creating new DOM elements, both HTML and SVG
Manipulating (existing) DOM elements
Defining Web Components
Misc utilities: promises, deferreds, render animation frames, etc.

Immediate Custom Element Web Componet API:

<section>
  <imm-demo-cdn data-demo=yes kind=awesome title='my demo title'>
    some body text for the CDN demo
  </imm-demo-cdn>

  <script type=module>
    import {imm_html as h, ImmElem} from 'https://cdn.jsdelivr.net/npm/imm-dom@latest/esm/index.js'

    ImmElem.elem('imm-demo-cdn', ns =>
      h.article(
        {class: ns.kind},
        h.h3(`${ns.title}`),
        h.slot('Body text Slot')) )
  </script>
</section>

Inspired by:

Immediate DOM API:

imm_html.article({class: 'awesome'},
  imm_html.h3('my demo title'),
  'some body text')

// or

tag('article', {class: 'awesome'},
  tag('h3', 'my demo title'),
  'some body text')

Inspired by:

Immediate Template API:

imm_tmpl`
  <article ${ {class: 'awesome'} }>
    <h3>${ 'my demo title' }</h3>
    ${ 'some body text' }
  </article>`

Inspired by:

uce and uhtml

Immediate requestAnimationFrame API

imm_raf() returns a promise for the next requestAnimationFrame tick.
ImmRAF is like ImmElem using requestAnimationFrame to decouple attribute updates from rendering.

Size Cost in Bytes

To be embedded in each web component custom element, the individual pieces must be small. Thus imm-dom is designed to include only the parts actually used when paired with a tree-shaking tool like rollup.

One component might only use imm_set() from imm_dom_core.js for ~ 1350 bytes minified; ~ 700 brotli.

An web component may take advantage of ImmElem from imm_elem.js for ~ 2700 bytes minified; ~ 1200 brotli.

A heavy rendering component may take advantage of ImmRAF from imm_elem_raf.js for ~ 3200 bytes minified; ~ 1500 brotli.

The entire library is ~ 9500 bytes minified; ~ 4000 brotli -- perfect for bundling a larger web component library and sharing structure.