#BlackLivesMatter

unified

Project: rehypejs/rehype-dom

Package: rehype-dom@6.0.1

  1. Dependents: 0
  2. unified processor to use browser APIs to parse and stringify HTML
  1. 65%
  3. ISC
  4. 24
  1. 10.4 kB
  2. 413
  1. unified 177
  2. html 122
  3. rehype 86
  4. tree 44
  5. ast 35
  6. syntax 28
  7. parse 24
  8. stringify 19
  9. compile 14
  10. abstract 10
  11. dom 8
  12. process 7

rehype-dom

Build Coverage Downloads Size Sponsors Backers Chat

unified processor with support for parsing HTML input and serializing HTML as output.

Contents

What is this?

This is like rehype but for browsers.

When should I use this?

Use this package when you want to use rehype in browsers. There are some limitations: see the monorepo readme for info on when (not) to use rehype-dom.

Install

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

npm install rehype-dom

In Deno with esm.sh:

import {rehypeDom} from 'https://esm.sh/rehype-dom@7'

In browsers with esm.sh:

<script type="module">
  import {rehypeDom} from 'https://esm.sh/rehype-dom@7?bundle'
</script>

Use

Say our page example.html contains:

<!doctype html>
<title>Example</title>
<body>
<script type="module">
  import {rehypeDom} from 'https://esm.sh/rehype-dom@7?bundle'

  const file = await rehypeDom().process('<h1>Hi <del>Mars</del>Venus!</h1>')

  document.body.innerHTML = String(file)
</script>

…opening it in a browser renders the following in <body>:

<h1>Hi <del>Mars</del>Venus!</h1>

API

This package exports the identifier rehypeDom. There is no default export.

rehypeDom()

Create a new unified processor that already uses rehype-dom-parse and rehype-dom-stringify.

You can add more plugins with use. See unified for more information.

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

Examples

Example: passing options

When you use rehype-dom-parse or rehype-dom-stringify manually you can pass options directly to them with use. Because both plugins are already used in rehype, that’s not possible. To define options for them, you can instead pass options to data:

import {rehypeDom} from 'https://esm.sh/rehype-dom@7?bundle'

const file = await rehypeDom()
  .data('settings', {fragment: false})
  .process('<!doctype html>' + document.documentElement.outerHTML)

console.log(String(file))

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 no additional types.

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.

/**
 * @typedef {import('rehype-dom')}
 */

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

Security

Use of rehype-dom 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