https://github.com/snabbdom/snabbdom-to-html

Render Snabbdom Vnode’s to HTML strings
https://github.com/snabbdom/snabbdom-to-html

snabbdom

Last synced: 1 day ago
JSON representation

Render Snabbdom Vnode’s to HTML strings

• Host: GitHub
• URL: https://github.com/snabbdom/snabbdom-to-html
• Owner: snabbdom
• Created: 2015-12-07T16:20:16.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-04-16T21:47:07.000Z (over 1 year ago)
• Last Synced: 2024-10-29T20:21:26.524Z (15 days ago)
• Topics: snabbdom
• Language: JavaScript
• Homepage:
• Size: 516 KB
• Stars: 94
• Watchers: 4
• Forks: 21
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Snabbdom to HTML

Render [Snabbdom](https://github.com/paldepind/snabbdom) Vnode’s to HTML strings

## Install

With [`npm`](https://www.npmjs.com/) do:

```bash

npm install snabbdom-to-html

```

## Usage

```js

var h = require('snabbdom/h')

var toHTML = require('snabbdom-to-html')

var output = toHTML(

  h('div', { style: { color: 'red' } }, 'The quick brown fox jumps')

)

console.log(output)

// => 
The quick brown fox jumps

```


### Advanced usage

This library is built replicating the modular approach used in Snabbdom. So you can do the following if you need to implement any custom functionality.

```js

var h = require('snabbdom/h')

var init = require('snabbdom-to-html/init')

var modules = require('snabbdom-to-html/modules')

var toHTML = init([

  modules.class,

  modules.props,

  modules.attributes,

  modules.style

])

var output = toHTML(

  h('div', { style: { color: 'lime' } }, 'over the lazy fox')

)

console.log(output)

// => 
over the lazy fox

```


The `init` function accepts an array of functions (modules). Modules have the following signature: `(vnode, attributes) => undefined`, where `attributes` is an [ES2015 Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance.

You can do `attributes.set(key, value)`, `attributes.get(key)` and `attributes.delete(key)` and so on. You can check out the built-in modules to get the idea.

The built-in modules are available from `snabbdom-to-html/modules`, and these are:

- `attributes`

- `class`

- `props`

- `style`

## Support

This is tested against Node.js 4.x and up. If you need to run this in the browser you might need to include something like [`es6-shim`](https://github.com/paulmillr/es6-shim) to ensure `Map` support. 

## License

MIT