hast-util-to-dom
Advanced tools
hast utility to transform to a DOM tree.
This package is a utility that creates a DOM tree (defaulting to the actual DOM
but also supporting things like jsdom) from a hast (HTML) syntax
tree.
You can use this project when you want to turn hast into a DOM in browsers,
either to use it directly on a page, or to enable the use of DOM APIs (such as
querySelector to find things or innerHTML to serialize stuff).
The hast utility hast-util-from-dom does the inverse of
this utility.
It turns DOM trees into hast.
The rehype plugin rehype-dom-stringify wraps this
utility to serialize as HTML with DOM APIs.
This package is ESM only. In Node.js (version 14.14+ or 16.0+), install with npm:
npm install hast-util-to-dom
In Deno with esm.sh:
import {toDom} from 'https://esm.sh/hast-util-to-dom@3'
In browsers with esm.sh:
<script type="module">
import {toDom} from 'https://esm.sh/hast-util-to-dom@3?bundle'
</script>
Say our page example.html looks as follows:
<!doctype html>
<title>Example</title>
<body>
<script type="module">
import {h} from 'https://esm.sh/hastscript?bundle'
import {toDom} from 'https://esm.sh/hast-util-to-dom?bundle'
const tree = h('main', [
h('h1', 'Hi'),
h('p', [h('em', 'Hello'), ', world!'])
])
document.body.append(toDom(tree))
</script>
Now running open example.html shows the main, h1, and p elements on the
page.
This package exports the identifier toDom.
There is no default export.
toDom(tree[, options])Turn a hast tree into a DOM tree.
DOM node (DomNode).
AfterTransformCallback called when each node is transformed (TypeScript type).
Nothing.
OptionsConfiguration (TypeScript type).
afterTransform (AfterTransform, optional)
— callback called when each node is transformeddocument (Document, default: globalThis.document)
— document interface to use.fragment (boolean, default: false)
— whether to return a DOM fragment (true) or a whole document (false)namespace (string, default: depends)
— namespace to use to create elementsThe syntax tree is hast.
This package is fully typed with TypeScript.
It exports the additional types AfterTransform and Options.
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
Use of hast-util-to-dom can open you up to a
cross-site scripting (XSS) attack if the hast tree is unsafe.
Use hast-util-santize to make the hast tree safe.
hast-util-sanitize
— sanitize hast nodeshast-util-to-html
— serialize as HTMLhast-util-from-dom
— create a hast tree from a DOM treeSee contributing.md in syntax-tree/.github for
ways to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
hast utility to transform to the DOM
The npm package hast-util-to-dom receives a total of 2,916 weekly downloads. As such, hast-util-to-dom popularity was classified as popular.
We found that hast-util-to-dom 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
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.