Hyperapp Render


This library is allowing you to render
Hyperapp views to an HTML string.

- User experience — Generate HTML on the server and send the markup
down on the initial request for faster page loads. Built-in
mounting
feature in Hyperapp is allowing you to have a very performant first-load experience.
- Accessibility — Allow search engines to crawl your pages for
SEO purposes.
- Testability — Check HTML validity and use
snapshot testing
to improve quality of your software.

Getting Started

Our first example is an interactive app from which you can generate an HTML markup.
Go ahead and try it online.

``jsx
import { h } from 'hyperapp'
import { renderToString } from 'hyperapp-render'

const state = {
text: 'Hello'
}

const actions = {
setText: text => ({ text })
}

const view = (state, actions) => (


{state.text.trim() === '' ? '👋' : state.text}

actions.setText(e.target.value)} />

)

const html = renderToString(view(state, actions))

console.log(html) // =>

Hello

`

Looking for a boilerplate?
Try Hyperapp Starter
with pre-configured server-side rendering and many more.

Installation

Using npm:

`bash
npm install hyperapp-render --save
`

Or using a CDN like
unpkg.com or
jsDelivr
with the following script tag:

`html

`

You can find the library in window.hyperappRender.

We support all ES5-compliant browsers, including Internet Explorer 9 and above,
but depending on your target browsers you may need to include
polyfills>) for
Set and
Map
before any other code.

Usage

The library provides two functions
which you can use depending on your needs or personal preferences:

`jsx
import { renderToString, renderToStream } from 'hyperapp-render'

renderToString() // =>
renderToString(view(state, actions)) // =>
renderToString(view, state, actions) // =>

renderToStream() // => =>
renderToStream(view(state, actions)) // => =>
renderToStream(view, state, actions) // => =>
`

Note: renderToStream is available from
Node.js environment only (v6 or newer).

Overview

You can use renderToString function to generate HTML on the server
and send the markup down on the initial request for faster page loads
and to allow search engines to crawl your pages for
SEO purposes.

If you call hyperapp.app()
on a node that already has this server-rendered markup,
Hyperapp will preserve it and only attach event handlers, allowing you
to have a very performant first-load experience.

The renderToStream function returns a
Readable stream
that outputs an HTML string.
The HTML output by this stream is exactly equal to what renderToString would return.
By using this function you can reduce TTFB
and improve user experience even more.

Caveats

The library automatically escapes text content and attribute values
of virtual DOM nodes
to protect your application against
XSS attacks.
However, it is not safe to allow "user input" for node names or attribute keys:

`jsx
const Node = 'div onclick="alert()"'
renderToString(Hi)
// =>

const attributes = { 'onclick="alert()" title': 'XSS' }
renderToString(

)
// =>

Hi

const userInput = ''
renderToString(

Hi

)
// =>

``

License

Hyperapp Render is MIT licensed.
See LICENSE.