unified

Project: syntax-tree/hast-util-transparent

Package: hast-util-transparent@2.0.0

  1. Dependencies: 2·Dependents: 0
  2. hast utility to check if a node is a transparent element
  1. util 128
  2. utility 124
  3. unist 119
  4. html 110
  5. hast 61
  6. hast-util 40
  7. category 7

hast-util-transparent

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to check if node is a transparent element.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install hast-util-transparent

Use

import {transparent} from 'hast-util-transparent'

transparent({
  type: 'element',
  tagName: 'div',
  children: [{type: 'text', value: 'Alpha'}]
}) // => false

transparent({
  type: 'element',
  tagName: 'a',
  properties: {href: '#bravo', title: 'Charlie'},
  children: [{type: 'text', value: 'Delta'}]
}) // => true

API

This package exports the following identifiers: transparent. There is no default export.

transparent(node)

Check if the given value is a transparent element.

Parameters
Returns

boolean — whether node passes the test.

Security

hast-util-transparent does not change the syntax tree so there are no openings for cross-site scripting (XSS) attacks.

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