npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rehype-dom-parse

v5.0.2

Published

rehype plugin to use browser APIs to parse HTML

Downloads

20,746

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

remcohaszingremcohaszingwooormwooormkmckkmck

Keywords

abstractastdomhtmlparserehypesyntaxtreeunified

Readme

rehype-dom-parse

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to add support for parsing HTML input in browsers.

Contents

What is this?

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

This plugin is built on 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. In Node.js (version 16+), install with npm:

npm install rehype-dom-parse

In Deno with esm.sh:

import rehypeDomParse from 'https://esm.sh/rehype-dom-parse@5'

In browsers with esm.sh:

<script type="module">
  import rehypeDomParse from 'https://esm.sh/rehype-dom-parse@5?bundle'
</script>

Use

Say our page example.html contains:

<!doctype html>
<title>Example</title>
<body>
<script type="module">
  import rehypeDomParse from 'https://esm.sh/rehype-dom-parse@5?bundle'
  import rehypeRemark from 'https://esm.sh/rehype-remark@10?bundle'
  import remarkStringify from 'https://esm.sh/remark-stringify@11?bundle'
  import {unified} from 'https://esm.sh/unified@11?bundle'

  const file = await unified()
    .use(rehypeDomParse)
    .use(rehypeRemark)
    .use(remarkStringify)
    .process(`<h1>Hi</h1>
<p><em>Hello</em>, world!</p>`)

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

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

# Hi

*Hello*, world!

API

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

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

Add support for parsing from HTML with DOM APIs.

Parameters
  • options (Options, optional) — configuration
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
  • 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.

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