MCPcopy Index your code
hub / github.com/developit/undom

github.com/developit/undom @0.4.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.4.0 ↗ · + Follow
50 symbols 100 edges 6 files 0 documented · 0% 1 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

undom

NPM travis-ci

Minimally viable DOM Document implementation

A bare-bones HTML DOM in a box. If you want the DOM but not a parser, this might be for you.

1kB, works in Node and browsers, plugins coming soon!

JSFiddle Demo: Rendering preact components into an undom Document.

preview


Project Goals

Undom aims to find a sweet spot between size/performance and utility. The goal is to provide the simplest possible implementation of a DOM Document, such that libraries relying on the DOM can run in places where there isn't one available.

The intent to keep things as simple as possible means undom lacks some DOM features like HTML parsing & serialization, Web Components, etc. These features can be added through additional libraries.


Installation

Via npm:

npm install --save undom


Require Hook

In CommonJS environments, simply import undom/register to patch the global object with a singleton Document.

require('undom/register');

// now you have a DOM.
document.createElement('div');

Usage

// import the library:
import undom from 'undom';

let document = undom();

let foo = document.createElement('foo');
foo.appendChild(document.createTextNode('Hello, World!'));
document.body.appendChild(foo);

Recipe: Serialize to HTML

One task undom doesn't handle for you by default is HTML serialization. A proper implementation of this would be cumbersome to maintain and would rely heavily on getters and setters, which limits browser support. Below is a simple recipe for serializing an undom Element (Document, etc) to HTML.

Small & in ES2015:

Element.prototype.toString = el => this.nodeType===3 ? enc(this.textContent) : (
    '<'+this.nodeName.toLowerCase() + this.attributes.map(attr).join('') + '>' +
    this.childNodes.map(serialize).join('') + '</'+this.nodeName.toLowerCase()+'>'
);
let attr = a => ` ${a.name}="${enc(a.value)}"`;
let enc = s => s.replace(/[&'"<>]/g, a => `&#${a};`);

ES3 Version

This also does pretty-printing.

function serialize(el) {
    if (el.nodeType===3) return el.textContent;
    var name = String(el.nodeName).toLowerCase(),
        str = '<'+name,
        c, i;
    for (i=0; i<el.attributes.length; i++) {
        str += ' '+el.attributes[i].name+'="'+el.attributes[i].value+'"';
    }
    str += '>';
    for (i=0; i<el.childNodes.length; i++) {
        c = serialize(el.childNodes[i]);
        if (c) str += '\n\t'+c.replace(/\n/g,'\n\t');
    }
    return str + (c?'\n':'') + '</'+name+'>';
}

function enc(s) {
    return s.replace(/[&'"<>]/g, function(a){ return `&#${a};` });
}

Core symbols most depended-on inside this repo

addEventListener
called by 23
src/undom.js
appendChild
called by 13
src/undom.js
setAttribute
called by 8
src/undom.js
dispatchEvent
called by 8
src/undom.js
toLower
called by 6
src/util.js
removeEventListener
called by 6
src/undom.js
findWhere
called by 5
src/util.js
getAttribute
called by 5
src/undom.js

Shape

Method 28
Function 12
Class 10

Languages

TypeScript100%

Modules by API surface

src/undom.js44 symbols
src/util.js5 symbols
test/undom.js1 symbols

Used by 1 indexed graphs manifest dependencies, hub-wide

For agents

$ claude mcp add undom \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact