Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/developit/undom
🍩 1kb minimally viable DOM Document implementation
https://github.com/developit/undom
domdocument html html-document polyfill preact serialization shim
Last synced: 6 days ago
JSON representation
🍩 1kb minimally viable DOM Document implementation
- Host: GitHub
- URL: https://github.com/developit/undom
- Owner: developit
- License: mit
- Created: 2016-07-09T02:38:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-03T15:58:04.000Z (almost 4 years ago)
- Last Synced: 2025-01-19T11:09:27.178Z (13 days ago)
- Topics: domdocument, html, html-document, polyfill, preact, serialization, shim
- Language: JavaScript
- Homepage: https://npm.im/undom
- Size: 43.9 KB
- Stars: 675
- Watchers: 10
- Forks: 25
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# undom
[](https://www.npmjs.org/package/undom)
[](https://travis-ci.org/developit/undom)
### **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:**](https://jsfiddle.net/developit/4qv3v6r3/) Rendering [preact](https://github.com/developit/preact/) components into an undom Document.
[](https://jsfiddle.net/developit/4qv3v6r3/)
---
## 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.
#### Looking to 1.0.0
As of version 1.0.0, the DOM constructors and their prototypes will be shared for all instances of a document, as is the case with [JSDOM](https://github.com/jsdom/jsdom#shared-constructors-and-prototypes). Once merged, [PR #25](https://github.com/developit/undom/pull/25) will address this by adding an `undom.env()` function, which returns a fresh document factory with a new set of constructors & prototypes.
---
## 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.
```js
require('undom/register');
// now you have a DOM.
document.createElement('div');
```
---
## Usage
```js
// 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:
```js
Element.prototype.toString = function() { return serialize(this); };
function serialize(el) {
return el.nodeType==3 ? enc(el.nodeValue) : (
'<'+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.codePointAt(0)};`);
```
#### ES3 Version
This also does pretty-printing.
```js
function serialize(el) {
if (el.nodeType===3) return el.textContent;
var name = String(el.nodeName).toLowerCase(),
str = '<'+name,
c, i;
for (i=0; i';
for (i=0; i';
}
function enc(s) {
return s.replace(/[&'"<>]/g, function(a){ return `${a};` });
}
```