hast-util-from-dom
Advanced tools
hast utility to transform from a DOM tree.
This package is a utility that takes a DOM tree (from the actual DOM or from
things like jsdom) as input and turns it into a hast (HTML)
syntax tree.
You can use this project when you want to use hast in browsers. This package is very small, but it does so by:
The hast utility hast-util-to-dom does the inverse of this
utility.
It turns hast into a DOM tree.
The rehype plugin rehype-dom-parse wraps this utility to
parse HTML with DOM APIs.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install hast-util-from-dom
In Deno with esm.sh:
import {fromDom} from 'https://esm.sh/hast-util-from-dom@5'
In browsers with esm.sh:
<script type="module">
import {fromDom} from 'https://esm.sh/hast-util-from-dom@5?bundle'
</script>
Say our page example.html looks as follows:
<!doctype html>
<title>Example</title>
<body>
<main>
<h1>Hi</h1>
<p><em>Hello</em>, world!</p>
</main>
<script type="module">
import {fromDom} from 'https://esm.sh/hast-util-from-dom@4?bundle'
const hast = fromDom(document.querySelector('main'))
console.log(hast)
</script>
Now running open example.html prints the following to the console:
{type: "element", tagName: "main", properties: {}, children: Array}
This package exports the identifier fromDom.
There is no default export.
fromDom(tree, options?)Transform a DOM tree to a hast tree.
Equivalent hast node (HastNode).
AfterTransformCallback called when each node is transformed (TypeScript type).
Nothing.
OptionsConfiguration (TypeScript type).
afterTransform (AfterTransform, optional)
— callback called when each node is transformedThis package is fully typed with TypeScript.
It exports the additional types AfterTransform and
Options.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, hast-util-from-dom@^5,
compatible with Node.js 16.
Use of hast-util-from-dom itself is safe but see other utilities for more
information on potential security problems.
See 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, organisation, or community you agree to abide by its terms.
hast-util-from-html
— parse hast from a string of HTMLhast-util-sanitize
— sanitize hast nodeshast-util-to-html
— serialize hast as HTMLhast-util-to-dom
— create DOM trees from hastThe `rehype-parse` package is used to parse HTML into a HAST tree directly from an HTML string. Unlike `hast-util-from-dom`, which converts existing DOM nodes to HAST, `rehype-parse` works directly with HTML strings and is part of the unified collective of tools for processing content.
FAQs
hast utility to create a tree from the DOM
The npm package hast-util-from-dom receives a total of 1,238,046 weekly downloads. As such, hast-util-from-dom popularity was classified as popular.
We found that hast-util-from-dom demonstrated a healthy version release cadence and project activity because the last version was released less than 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.
Product
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.
Security News
Open source dashboard CNAPulse tracks CVE Numbering Authorities’ publishing activity, highlighting trends and transparency across the CVE ecosystem.
Product
Detect malware, unsafe data flows, and license issues in GitHub Actions with Socket’s new workflow scanning support.