hast-util-embedded

hast utility to check if a node is embedded content.

What is this?
When should I use this?
Install
Use
API
- embedded(value)
Types
Compatibility
Security
Related
Contribute
License

What is this?

This package is a small utility that checks if a node is embedded content according to HTML.

When should I use this?

This utility is super niche, if you’re here you probably know what you’re looking for!

Install

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

npm install hast-util-embedded

In Deno with esm.sh:

import {embedded} from 'https://esm.sh/hast-util-embedded@2'

In browsers with esm.sh:

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

Use

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

// Given a non-embedded value:
embedded({
  type: 'element',
  tagName: 'a',
  properties: {href: '#alpha', title: 'Bravo'},
  children: [{type: 'text', value: 'Charlie'}]
}) // => false

// Given a embedded element:
embedded({
  type: 'element',
  tagName: 'audio',
  properties: {src: 'delta.ogg'},
  children: []
}) // => true

API

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

`embedded(value)`

Check if node is an embedded content.

Parameters

value (unknown) — thing to check (typically Node)

Returns

Whether value is an element considered embedded content (boolean).

The elements audio, canvas, embed, iframe, img, math, object, picture, svg, and video are embedded content.

Types

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

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

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

hast-util-is-element — check if a node is a (certain) element
hast-util-has-property — check if a node has a property
hast-util-is-body-ok-link — check if a node is “Body OK” link element
hast-util-is-conditional-comment — check if a node is a conditional comment
hast-util-is-css-link — check if a node is a CSS link element
hast-util-is-css-style — check if a node is a CSS style element
hast-util-heading — check if a node is a heading element
hast-util-interactive — check if a node is interactive
hast-util-is-javascript — check if a node is a JavaScript script element
hast-util-labelable — check whether a node is labelable
hast-util-phrasing — check if a node is phrasing content
hast-util-script-supporting — check if a node is a script-supporting element
hast-util-sectioning — check if a node is a sectioning element
hast-util-transparent — check if a node is a transparent element
hast-util-whitespace — check if a node is inter-element whitespace

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.

hast-util-embedded

Contents