rehype-dom

unified processor to use browser APIs to parse and stringify HTML

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rehype-dom
7.0.08 months ago6 years agoMinified + gzip package size for rehype-dom in KB

Popular Searches

Readme

rehype-dom
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
unified processor with support for parsing HTML input and serializing HTML as output.

Contents

*   [`rehypeDom()`](#rehypedom)
*   [Example: passing options](#example-passing-options)

What is this?

This is like rehyperehype 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 readmerehype-dom for info on when (not) to use rehype-dom.

Install

This package is ESM onlyesm. In Node.js (version 16+), install with npm:
npm install rehype-dom

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

In browsers with esm.shesmsh:
<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 rehypeDomapi-rehype-dom. There is no default export.

rehypeDom()

Create a new unified processor that already uses rehype-dom-parserehype-dom-parse and rehype-dom-stringifyrehype-dom-stringify.
You can add more plugins with use. See unifiedunified 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)xss attack if dangerous content is used and the result is used with the actual DOM. Use rehype-sanitizerehype-sanitize to solve that.

Contribute

See contributing.mdcontributing in rehypejs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

ISClicense © Keith McKnightauthor