posthtml-render
Advanced tools
Changelog
Readme
Renders a PostHTML Tree to HTML/XML
npm i -D posthtml-render
ℹ️ This module is also available for bower and as an AMD, CommonJS and IIFE (global) module, uncompressed and compressed
NodeJSconst render = require('posthtml-render')
const tree = []
const node = {}
node.tag = 'ul'
node.attrs = { class: 'list' }
node.content = [
'one',
'two',
'three'
].map((content) => ({ tag: 'li', content }))
tree.push(node)
const html = render(tree, options)
<ul class="list">
<li>one</li>
<li>two</li>
<li>three</li>
</ul>
🌐 Browser<!DOCTYPE html>
<html>
<head>
<title>Title</title>
<script src="./node_modules/posthtml-render/lib/browser.min.js"></script>
<script >
const tree = {
tag: 'h1',
attrs: {
style: 'color: red;'
},
content: [ 'Title' ]
}
window.onload = function () {
document.body.innerHTML = render(tree)
}
</script>
</head>
<body></body>
</html>
| Name | Type | Default | Description |
|---|---|---|---|
singleTags | {Array<String|RegExp>} | [] | Specify custom single tags (self closing) |
closingSingleTag | {String} | > | Specify the single tag closing format |
quoteAllAttributes | {Boolean} | true | Put double quotes around all tags, even when not necessary. |
replaceQuote | {Boolean} | true | Replaces quotes in attribute values with "e;. |
quoteStyle | {0 or 1 or 2} | 2 | Specify the style of quote arround the attribute values |
singleTagsSpecify custom single tags (self closing)
{String}const render = require('posthtml-render')
const tree = [ { tag: 'name' } ]
const options = { singleTags: [ 'name' ] }
const html = render(tree, options)
result.html
<name>
{RegExp}const render = require('posthtml-render')
const tree = [ { tag: '%=title%' } ]
const options = { singleTags: [ /^%.*%$/ ] }
const html = render(tree, options)
result.html
<%=title%>
closingSingleTagSpecify the single tag closing format
Formatsconst render = require('posthtml-render')
const tree = [ { tag: 'img' } ]
'tag'const html = render(tree, { closingSingleTag: 'tag' })
<custom></custom>
'slash'const html = render(tree, { closingSingleTag: 'slash' })
<custom />
'default' (Default)const html = render(tree)
<img>
'closeAs'const tree = [ {
tag: 'custom',
closeAs: 'default' // Available types: `tag` | `slash` | `default`
} ]
const html = render(tree, { closingSingleTag: 'closeAs' })
<custom>
quoteAllAttributesSpecify if all attributes should be quoted.
true (Default)<i src="index.js"></i>
false<i src=index.js></i>
replaceQuoteReplaces quotes in attribute values with "e;.
true (Default)<img src="<?php echo $foo["e;bar"e;] ?>">
false<img src="<?php echo $foo["bar"] ?>">
quoteStyle2 (Default)Attribute values are wrapped in double quotes:
<img src="https://example.com/example.png" onload="testFunc("test")">
1Attribute values are wrapped in single quote:
<img src='https://example.com/example.png' onload='testFunc("test")'>
0Quote style is based on attribute values (an alternative for replaceQuote option):
<img src="https://example.com/example.png" onload='testFunc("test")'>
FAQs
Renders PostHTML Tree to HTML/XML
The npm package posthtml-render receives a total of 536,939 weekly downloads. As such, posthtml-render popularity was classified as popular.
We found that posthtml-render demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.