Support for HTML-style comments: <div><!-- comment --></div>
Installation
htm is published to npm, and accessible via the unpkg.com CDN:
via npm:
npm i htm
hotlinking from unpkg:(no build tool needed!)
import htm from 'https://unpkg.com/htm?module'const html = htm.bind(React.createElement);
// just want htm + preact in a single file? there's a highly-optimized version of that:import { html, render } from 'https://unpkg.com/htm/preact/standalone.module.js'
Usage
If you're using Preact or React, we've included off-the-shelf bindings to make your life easier.
They also have the added benefit of sharing a template cache across all modules.
import { render } from 'preact';import { html } from 'htm/preact';render(html`<a href="/">Hello!</a>`, document.body);
Similarly, for React:
import ReactDOM from 'react-dom';import { html } from 'htm/react';ReactDOM.render(html`<a href="/">Hello!</a>`, document.body);
Advanced Usage
Since htm is a generic library, we need to tell it what to "compile" our templates to.
You can bind htm to any function of the form h(type, props, ...children)(hyperscript).
This function can return anything - htm never looks at the return value.
Here's an example h() function that returns tree nodes:
function h(type, props, ...children) { return { type, props, children };}
To use our custom h() function, we need to create our own html tag function by binding htm to our h() function:
import htm from 'htm';const html = htm.bind(h);
Now we have an html() template tag that can be used to produce objects in the format we created above.
The default build of htm caches template strings, which means that it can return the same Javascript object at multiple points in the tree. If you don't want this behaviour, you have three options:
Change your h function to copy nodes when needed.
Add the code this[0] = 3; at the beginning of your h function, which disables caching of created elements.
Use htm/mini, which disables caching by default.
Example
Curious to see what it all looks like? Here's a working app!
It's a single HTML file, and there's no build or tooling. You can edit it with nano.
The original goal for htm was to create a wrapper around Preact that felt natural for use untranspiled in the browser. I wanted to use Virtual DOM, but I wanted to eschew build tooling and use ES Modules directly.
This meant giving up JSX, and the closest alternative was Tagged Templates. So, I wrote this library to patch up the differences between the two as much as possible. The technique turns out to be framework-agnostic, so it should work great with any library or renderer that works with JSX.
htm is stable, fast, well-tested and ready for production use.