https://github.com/syntax-tree/hast-util-to-dom

utility to transform hast to a DOM tree
https://github.com/syntax-tree/hast-util-to-dom

dom hast hast-util html syntax-tree unist util

Last synced: about 1 month ago
JSON representation

utility to transform hast to a DOM tree

Host: GitHub
URL: https://github.com/syntax-tree/hast-util-to-dom
Owner: syntax-tree
License: isc
Created: 2018-06-04T15:16:58.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2025-02-19T15:16:40.000Z (4 months ago)
Last Synced: 2025-04-22T08:50:19.754Z (about 2 months ago)
Topics: dom, hast, hast-util, html, syntax-tree, unist, util
Language: JavaScript
Homepage: https://unifiedjs.com
Size: 939 KB
Stars: 20
Watchers: 8
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

awesome-syntax-tree - hast-util-to-dom - Transform to a DOM tree. (hast utilities)

README

        # hast-util-to-dom

[![Build][badge-build-image]][badge-build-url]

[![Coverage][badge-coverage-image]][badge-coverage-url]

[![Downloads][badge-downloads-image]][badge-downloads-url]

[![Size][badge-size-image]][badge-size-url]

[hast][github-hast] utility to transform to a [DOM][mozilla-dom] tree.

## Contents

* [What is this?](#what-is-this)

* [When should I use this?](#when-should-i-use-this)

* [Install](#install)

* [Use](#use)

* [API](#api)

  * [`toDom(tree[, options])`](#todomtree-options)

  * [`AfterTransform`](#aftertransform)

  * [`Options`](#options)

* [Syntax tree](#syntax-tree)

* [Types](#types)

* [Compatibility](#compatibility)

* [Security](#security)

* [Related](#related)

* [Contribute](#contribute)

* [License](#license)

## What is this?

This package is a utility that creates a DOM tree

(defaulting to the actual DOM but also supporting things like

[`jsdom`][github-jsdom])

from a [hast][github-hast] (HTML) syntax tree.

## When should I use this?

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`][github-hast-util-from-dom] does the

inverse of this utility.

It turns DOM trees into hast.

The rehype plugin [`rehype-dom-stringify`][github-rehype-dom-stringify] wraps

this utility to serialize as HTML with DOM APIs.

## Install

This package is [ESM only][github-gist-esm].

In Node.js (version 16+),

install with [npm][npmjs-install]:

```sh

npm install hast-util-to-dom

```

In Deno with [`esm.sh`][esmsh]:

```js

import {toDom} from 'https://esm.sh/hast-util-to-dom@4'

```

In browsers with [`esm.sh`][esmsh]:

```html

  import {toDom} from 'https://esm.sh/hast-util-to-dom@4?bundle'

```

## Use

Say our page `example.html` looks as follows:

```html

Example

  

    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))

  

```

Now running `open example.html` shows the

`main`,

`h1`,

and `p` elements on the page.

## API

This package exports the identifier [`toDom`][api-to-dom].

There is no default export.

### `toDom(tree[, options])`

Turn a hast tree into a DOM tree.

###### Parameters

* `tree`

  ([`HastNode`][github-hast-nodes])

  — tree to transform

* `options`

  ([`Options`][api-options], optional)

  — configuration

###### Returns

DOM node ([`DomNode`][mozilla-dom-node]).

### `AfterTransform`

Callback called when each node is transformed (TypeScript type).

###### Parameters

* `hastNode` ([`HastNode`][github-hast-nodes])

  — hast node that was handled

* `domNode` ([`DomNode`][mozilla-dom-node])

  — corresponding DOM node

###### Returns

Nothing.

### `Options`

Configuration (TypeScript type).

###### Fields

* `afterTransform`

  ([`AfterTransform`][api-after-transform], optional)

  — callback called when each node is transformed

* `document`

  (`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 elements

## Syntax tree

The syntax tree is [hast][github-hast].

## Types

This package is fully typed with [TypeScript][].

It exports the additional types [`AfterTransform`][api-after-transform] and

[`Options`][api-options].

## Compatibility

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-to-dom@4`,

compatible with Node.js 16.

## Security

Use of `hast-util-to-dom` can open you up to a

[cross-site scripting (XSS)][wikipedia-xss] attack if the hast tree is unsafe.

Use [`hast-util-santize`][github-hast-util-sanitize] to make the hast tree

safe.

## Related

* [`hast-util-sanitize`][github-hast-util-sanitize]

  — sanitize hast nodes

* [`hast-util-to-html`](https://github.com/syntax-tree/hast-util-to-html)

  — serialize as HTML

* [`hast-util-from-dom`][github-hast-util-from-dom]

  — create a hast tree from a DOM tree

## Contribute

See [`contributing.md`][health-contributing]

in

[`syntax-tree/.github`][health]

for ways to get started.

See [`support.md`][health-support] for ways to get help.

This project has a [code of conduct][health-coc].

By interacting with this repository,

organization,

or community you agree to abide by its terms.

## License

[ISC][file-license] © [Keith McKnight][mcknight]

[api-after-transform]: #aftertransform

[api-options]: #options

[api-to-dom]: #todomtree-options

[badge-build-image]: https://github.com/syntax-tree/hast-util-to-dom/workflows/main/badge.svg

[badge-build-url]: https://github.com/syntax-tree/hast-util-to-dom/actions

[badge-coverage-image]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-to-dom.svg

[badge-coverage-url]: https://codecov.io/github/syntax-tree/hast-util-to-dom

[badge-downloads-image]: https://img.shields.io/npm/dm/hast-util-to-dom.svg

[badge-downloads-url]: https://www.npmjs.com/package/hast-util-to-dom

[badge-size-image]: https://img.shields.io/bundlejs/size/hast-util-to-dom

[badge-size-url]: https://bundlejs.com/?q=hast-util-to-dom

[esmsh]: https://esm.sh

[file-license]: license

[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[github-hast]: https://github.com/syntax-tree/hast

[github-hast-nodes]: https://github.com/syntax-tree/hast#nodes

[github-hast-util-from-dom]: https://github.com/syntax-tree/hast-util-from-dom

[github-hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize

[github-jsdom]: https://github.com/jsdom/jsdom

[github-rehype-dom-stringify]: https://github.com/rehypejs/rehype-dom/tree/main/packages/rehype-dom-stringify

[health]: https://github.com/syntax-tree/.github

[health-coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[health-contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[health-support]: https://github.com/syntax-tree/.github/blob/main/support.md

[mcknight]: https://keith.mcknig.ht

[mozilla-dom]: https://developer.mozilla.org/docs/Web/API/Document_Object_Model

[mozilla-dom-node]: https://developer.mozilla.org/docs/Web/API/Node

[npmjs-install]: https://docs.npmjs.com/cli/install

[typescript]: https://www.typescriptlang.org

[wikipedia-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/syntax-tree/hast-util-to-dom

Awesome Lists containing this project

README