# rehype-dom-parse
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[rehype][]** plugin to add support for parsing HTML input in browsers.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeDomParse[, options])`](#unifieduserehypedomparse-options)
* [`Options`](#options)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This is like [`rehype-parse`][rehype-parse] but for browsers.
This plugin uses DOM APIs to do its work, which makes it smaller in browsers, at
the cost of not supporting positional info on nodes.
## When should I use this?
Use this package when you want to use `rehype-parse` solely in browsers.
See [the monorepo readme][rehype-dom] for info on when to use `rehype-dom`.
This plugin is built on [`hast-util-from-dom`][hast-util-from-dom], which is a
low level tool to turn DOM nodes into hast syntax trees.
rehype focusses on making it easier to transform content by abstracting such
internals away.
## Install
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install rehype-dom-parse
```
In Deno with [`esm.sh`][esmsh]:
```js
import rehypeDomParse from 'https://esm.sh/rehype-dom-parse@5'
```
In browsers with [`esm.sh`][esmsh]:
```html
```
## Use
Say our page `example.html` contains:
```html
Example
```
…opening it in a browser prints the following to the browser console:
```markdown
# Hi
*Hello*, world!
```
## API
This package exports no identifiers.
The default export is [`rehypeDomParse`][api-rehype-dom-parse].
### `unified().use(rehypeDomParse[, options])`
Add support for parsing from HTML with DOM APIs.
###### Parameters
* `options` ([`Options`][api-options], optional)
— configuration
###### Returns
Transform ([`Transformer`][unified-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
* `fragment` (`boolean`, default: `true`)
— specify whether to parse a fragment
## 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`][api-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.
```js
/**
* @import {} from 'rehype-dom-parse'
*/
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-parse@^5`, compatible with Node.js 16.
## Security
Use of `rehype-dom-parse` is safe.
## Contribute
See [`contributing.md`][contributing] in [`rehypejs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.
## License
[ISC][license] © [Keith McKnight][author]
[build-badge]: https://github.com/rehypejs/rehype-dom/workflows/main/badge.svg
[build]: https://github.com/rehypejs/rehype-dom/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-dom.svg
[coverage]: https://codecov.io/github/rehypejs/rehype-dom
[downloads-badge]: https://img.shields.io/npm/dm/rehype-dom-parse.svg
[downloads]: https://www.npmjs.com/package/rehype-dom-parse
[size-badge]: https://img.shields.io/bundlejs/size/rehype-dom-parse
[size]: https://bundlejs.com/?q=rehype-dom-parse
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/rehypejs/rehype/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[author]: https://keith.mcknig.ht
[license]: https://github.com/rehypejs/rehype-dom/blob/main/license
[health]: https://github.com/rehypejs/.github
[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md
[support]: https://github.com/rehypejs/.github/blob/main/support.md
[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md
[hast]: https://github.com/syntax-tree/hast
[hast-util-from-dom]: https://github.com/syntax-tree/hast-util-from-dom
[rehype]: https://github.com/rehypejs/rehype
[rehype-dom]: https://github.com/rehypejs/rehype-dom
[rehype-parse]: https://github.com/rehypejs/rehype/tree/main/packages/rehype-parse
[typescript]: https://www.typescriptlang.org
[unified-transformer]: https://github.com/unifiedjs/unified#transformer
[api-options]: #options
[api-rehype-dom-parse]: #unifieduserehypedomparse-options