unified

Project: rehypejs/rehype-dom

Package: rehype-dom-stringify@3.0.1

  1. rehype plugin to use browser APIs to stringify HTML
  1. 64%
  3. ISC
  4. 27
  1. 5.72 B
  2. 61k
  1. unified 161
  2. html 120
  3. rehype 90
  4. tree 42
  5. ast 35
  6. syntax 26
  7. stringify 16
  8. compile 11
  9. abstract 10
  10. dom 7

rehype-dom-stringify

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to add support for serializing HTML in browsers.

Contents

What is this?

This is like rehype-stringify but for browsers. This plugin uses DOM APIs to do its work, which makes it smaller in browsers, at the cost of not supporting formatting options.

When should I use this?

Use this package when you want to use rehype-stringify solely in browsers. See the monorepo readme for info on when to use rehype-dom.

This plugin is built on hast-util-to-dom, which is a low level tool to turn hast syntax trees into DOM nodes. rehype focusses on making it easier to transform content by abstracting such internals away.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install rehype-dom-stringify

In Deno with esm.sh:

import rehypeDomStringify from 'https://esm.sh/rehype-dom-stringify@4'

In browsers with esm.sh:

<script type="module">
  import rehypeDomStringify from 'https://esm.sh/rehype-dom-stringify@4?bundle'
</script>

Use

Say our page example.html contains:

<!doctype html>
<title>Example</title>
<body>
<script type="module">
  import remarkParse from 'https://esm.sh/remark-parse@11?bundle'
  import remarkRehype from 'https://esm.sh/remark-rehype@11?bundle'
  import rehypeDomStringify from 'https://esm.sh/rehype-dom-stringify@4?bundle'
  import {unified} from 'https://esm.sh/unified@11?bundle'

  const file = await unified()
    .use(remarkParse)
    .use(remarkRehype)
    .use(rehypeDomStringify)
    .process('# Hello, world!')

  console.log(String(file))
</script>

…opening it in a browser prints the following to the browser console:

<h1>Hello, world!</h1>

API

This package exports no identifiers. The default export is rehypeDomStringify.

unified().use(rehypeDomStringify[, options])

Add support for serializing as HTML with DOM APIs.

Parameters
Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

👉 Note: the default of the fragment option is true in this package, which is different from the value in rehype-parse, as this makes more sense in browsers.

Fields

Syntax

HTML is parsed and serialized according to what a browser supports (which should be WHATWG HTML).

Syntax tree

The syntax tree used in rehype is hast.

Types

This package is fully typed with TypeScript. It exports the additional type Options.

It also registers Settings with unified. If you’re passing options with .data('settings', …), make sure to import this package somewhere in your types, as that registers the fields.

/**
 * @import {} from 'rehype-dom-stringify'
 */

import {unified} from 'unified'

// @ts-expect-error: `thisDoesNotExist` is not a valid option.
unified().data('settings', {thisDoesNotExist: false})

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, rehype-dom-stringify@^4, compatible with Node.js 16.

Security

Use of rehype-dom-stringify can open you up to a cross-site scripting (XSS) attack if dangerous content is used and the result is used with the actual DOM. Use rehype-sanitize to solve that.

Contribute

See contributing.md in rehypejs/.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.

License

ISC © Keith McKnight