unified

Project: syntax-tree/hast-util-parse-selector

Package: hast-util-parse-selector@3.1.1

  1. Dependents: 0
  2. hast utility to create an element from a simple CSS selector
  1. util 145
  2. utility 141
  3. unist 130
  4. html 121
  5. hast 74
  6. hast-util 46
  7. parse 24
  8. css 10
  9. selector 4

hast-util-parse-selector

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to create an element from a simple CSS selector.

Contents

What is this?

This package is a tiny utility that helps create elements.

When should I use this?

This utility is super niche. You probably want the more powerful hastscript or hast-util-from-selector

Install

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

npm install hast-util-parse-selector

In Deno with esm.sh:

import {parseSelector} from 'https://esm.sh/hast-util-parse-selector@3'

In browsers with esm.sh:

<script type="module">
  import {parseSelector} from 'https://esm.sh/hast-util-parse-selector@3?bundle'
</script>

Use

import {parseSelector} from 'hast-util-parse-selector'

console.log(parseSelector('.quux#bar.baz.qux'))

Yields:

{ type: 'element',
  tagName: 'div',
  properties: { id: 'bar', className: [ 'quux', 'baz', 'qux' ] },
  children: [] }

API

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

parseSelector(selector?[, defaultTagName])

Create a hast element from a simple CSS selector.

Parameters
Returns

Built element (Element).

Types

This package is fully typed with TypeScript. It exports no additional types.

In TypeScript 4.2+, the type system can infer the tag name of literal selectors and knows that the return element has that name.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

Improper use of the selector or defaultTagName can open you up to a cross-site scripting (XSS) attack as the value of tagName, when resolving to script, injects a script element into the syntax tree.

Do not use user input in selector or use hast-util-santize.

Contribute

See contributing.md in syntax-tree/.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, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer