Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shannonmoeller/apply-html
It's `.innerHTML = ''` for the 21st century.
https://github.com/shannonmoeller/apply-html
apply diff dom html js patch
Last synced: 20 days ago
JSON representation
It's `.innerHTML = ''` for the 21st century.
- Host: GitHub
- URL: https://github.com/shannonmoeller/apply-html
- Owner: shannonmoeller
- License: mit
- Created: 2018-01-10T20:07:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-20T15:26:19.000Z (about 6 years ago)
- Last Synced: 2024-10-03T18:46:04.225Z (about 1 month ago)
- Topics: apply, diff, dom, html, js, patch
- Language: JavaScript
- Homepage: http://npm.im/apply-html
- Size: 185 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# apply-html
[![NPM version][npm-img]][npm-url] [![Downloads][downloads-img]][npm-url] [![Build Status][travis-img]][travis-url] [![Coverage Status][coveralls-img]][coveralls-url]
It's `.innerHTML = ''` for the 21st century!
Yet another library to diff and patch an existing DOM tree by efficiently comparing it to a string. Why? This library is a little bit different than [others](#acknowledgements). It makes use of an [HTML ``'s](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/template) unique ability to create an inert [document fragment](https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment), featuring:
- A real DOM tree
- Multiple root nodes
- Will not trigger resource loading prematurely
- Will not apply embedded stylesheets prematurely
- Will not trigger custom element constructors or lifecycle events prematurely
The live DOM is then patched with the inert fragment using a hyper-fast [diffing algorithm](http://npm.im/nanomorph) for real DOM nodes. This ensures that things only start happening if and when they're supposed to, organically.
Play with it on [CodePen](https://codepen.io/shannonmoeller/pen/XZXBpE?editors=1111).
## Install
```command
$ npm install --save apply-html
```
or
```html
```
or
```html
import { apply, html } from 'https://unpkg.com/apply-html?module';
```
## Usage
### Patching
```js
const { apply } = require('apply-html');
apply(document.body, '
Hello World
');
console.log(document.body.innerHTML);
// ->
Hello World
apply(document.body, '
Goodnight Moon
');
console.log(document.body.innerHTML);
// ->
Goodnight Moon
```
### Interpolation and Escaping
```js
const { apply, html, raw } = require('apply-html');
const foo = 'foo';
const bar = raw('bar');
const baz = html`baz`;
apply(document.body, html`
${foo}
${bar}
${baz}
`);
console.log(document.body.innerHTML);
// -> <em>foo</em>
// -> bar
// -> baz
```
### Server-side Rendering
The `html` and `raw` functions never touch the DOM so they're completely safe to use server-side.
```js
const http = require('http');
const { html } = require('apply-html');
const content = html`
Hello World
How are you today?
`;
module.exports = http
.createServer((req, res) => res.end(content.toString()))
.listen(3000);
```
## API
### `apply(element, string): Element`
- `element` `{Element}` DOM element with children to be patched.
- `string` `{String|SafeString}` String or [SafeString](#safestring) containing safe HTML to render.
Updates the content of the given element, making the fewest possible changes required to match the given string of HTML. The string is converted into an HTML `` and the resulting DOM trees are compared. Returns the updated element.
### `` html`string`: SafeString ``
A template tag that creates a new [SafeString](#safestring) containing a string of HTML. Interpolated values are serialized based on type:
- `Array` - Items are serialized then joined with an empty string (`''`).
- `Boolean|null|undefined` - Converted to an empty string (`''`).
- `Function` - Throws a `TypeError`.
- `Number` - Inserted as-is.
- `Object` - Converted to an HTML-encoded JSON blob.
- `SafeString` - Inserted as-is.
- `String` - HTML-encoded to safeguard against [XSS](https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)). To opt out of escaping, use [`raw()`](#rawstring-safestring).
### `raw(string): SafeString`
- `string` `{String}` String of safe HTML.
Wraps a string in a [SafeString](#safestring) to indicate that it's safe to be inserted into the document. Only use on trusted strings to safeguard against [XSS](https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)).
## SafeString
### `.raw` `{String}`
The wrapped string.
### `.length` `{Number}`
Length of the wrapped string. Read only.
### `.toJSON(): String`
Returns the raw string.
### `.toString(): String`
Returns the raw string.
## Acknowledgements
Standing on the shoulders of these giants:
- [bel](http://npm.im/bel)
- [diff-dom](http://npm.im/diff-dom)
- [domdiff](http://npm.im/domdiff)
- [hyperhtml](http://npm.im/hyperhtml)
- [lit-html](http://npm.im/lit-html)
- [morphdom](http://npm.im/morphdom)
- [nanomorph](http://npm.im/nanomorph)
- [preact](http://nipm.im/preact)
- [snabbdom](http://npm.im/snabbdom)
- [react](http://nipm.im/react)
- [vue.js](http://npm.im/vue)
- and [more...](https://rawgit.com/krausest/js-framework-benchmark/master/webdriver-ts-results/table.html)
----
MIT © [Shannon Moeller](http://shannonmoeller.com)
[coveralls-img]: http://img.shields.io/coveralls/shannonmoeller/apply-html/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/shannonmoeller/apply-html
[downloads-img]: http://img.shields.io/npm/dm/apply-html.svg?style=flat-square
[npm-img]: http://img.shields.io/npm/v/apply-html.svg?style=flat-square
[npm-url]: https://npmjs.org/package/apply-html
[travis-img]: http://img.shields.io/travis/shannonmoeller/apply-html.svg?style=flat-square
[travis-url]: https://travis-ci.org/shannonmoeller/apply-html