wasm-metering
Version:
injects metering into webassembly binaries
184 lines (146 loc) • 4.04 kB
Markdown
# nanohtml
[![npm version][2]][3] [![build status][4]][5]
[![downloads][8]][9] [![js-standard-style][10]][11]
HTML template strings for the Browser with support for Server Side
Rendering in Node.
## Installation
```sh
$ npm install nanohtml
```
## Usage
### Browser
```js
var html = require('nanohtml')
var el = html`
<body>
<h1>Hello planet</h1>
</body>
`
document.body.appendChild(el)
```
### Node
Node doesn't have a DOM available. So in order to render HTML we use string
concatenation instead. This has the fun benefit of being quite efficient, which
in turn means it's great for server rendering!
```js
var html = require('nanohtml')
var el = html`
<body>
<h1>Hello planet</h1>
</body>
`
console.log(el.toString())
```
### Interpolating unescaped HTML
By default all content inside template strings is escaped. This is great for
strings, but not ideal if you want to insert HTML that's been returned from
another function (for example: a markdown renderer). Use `nanohtml/raw` for
to interpolate HTML directly.
```js
var raw = require('nanohtml/raw')
var html = require('nanohtml')
var string = '<h1>This a regular string.</h1>'
var el = html`
<body>
${raw(string)}
</body>
`
document.body.appendChild(el)
```
### Attaching event listeners
```js
var html = require('nanohtml')
var el = html`
<body>
<button onclick=${onclick}>
Click Me
</button>
</body>
`
document.body.appendChild(el)
function onclick (e) {
console.log(`${e.target} was clicked`)
}
```
## Static optimizations
Parsing HTML has significant overhead. Being able to parse HTML statically,
ahead of time can speed up rendering to be about twice as fast.
### Browserify
#### From the command line
```sh
$ browserify -t nanohtml index.js > bundle.js
```
#### Programmatically
```js
var browserify = require('browserify')
var nanohtml = require('nanohtml')
var path = require('path')
var b = browserify(path.join(__dirname, 'index.js'))
.transform(nanohtml)
b.bundle().pipe(process.stdout)
```
#### In package.json
```json
{
"name": "my-app",
"private": true,
"browserify": {
"transform": [
"nanohtml"
]
},
"dependencies": {
"nanohtml": "^1.0.0"
}
}
```
### Webpack
At the time of writing there's no Webpack loader yet. We'd love a contribution!
### Babel / Parcel
Add nanohtml to your `.babelrc` config.
Without options:
```js
{
"plugins": [
"nanohtml"
]
}
```
With options:
```js
{
"plugins": [
["nanohtml", {
"useImport": true
}]
]
}
```
#### Options
- `useImport` - Set to true to use `import` statements for injected modules.
By default, `require` is used. Enable this if you're using Rollup.
- `appendChildModule` - Import path to a module that contains an `appendChild`
function. Defaults to `"nanohtml/lib/append-child"`.
## Attributions
Shout out to [Shama](https://github.com/shama) and
[Shuhei](https://github.com/shuhei) for their contributions to
[Bel](https://github.com/shama/bel),
[yo-yoify](https://github.com/shama/yo-yoify) and
[pelo](https://github.com/shuhei/pelo). This module is based on their work, and
wouldn't have been possible otherwise!
## See Also
- [choojs/nanomorph](https://github.com/choojs/nanomorph)
## License
[MIT](./LICENSE)
[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
[2]: https://img.shields.io/npm/v/nanohtml.svg?style=flat-square
[3]: https://npmjs.org/package/nanohtml
[4]: https://img.shields.io/travis/choojs/nanohtml/master.svg?style=flat-square
[5]: https://travis-ci.org/choojs/nanohtml
[6]: https://img.shields.io/codecov/c/github/choojs/nanohtml/master.svg?style=flat-square
[7]: https://codecov.io/github/choojs/nanohtml
[8]: http://img.shields.io/npm/dt/nanohtml.svg?style=flat-square
[9]: https://npmjs.org/package/nanohtml
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard