hast utility to check if a node is an embedded element
npm install hast-util-embedded[![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]
[hast][] utility to check if a node is [embedded content][spec].
* What is this?
* When should I use this?
* Install
* Use
* API
* embedded(value)
* Types
* Compatibility
* Security
* Related
* Contribute
* License
This package is a small utility that checks if a node is embedded content
according to HTML.
This utility is super niche, if you’re here you probably know what you’re
looking for!
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install hast-util-embedded
In Deno with [esm.sh][esmsh]:
`js`
import {embedded} from 'https://esm.sh/hast-util-embedded@3'
In browsers with [esm.sh][esmsh]:
`html`
`js
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
`
This package exports the identifier [embedded][api-embedded].
There is no default export.
Check if node is an [embedded content][spec].
###### Parameters
* value (unknown)Node
— 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.
This package is fully typed with [TypeScript][].
It exports no additional types.
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, hast-util-embedded@^3,
compatible with Node.js 16.
hast-util-embedded does not change the syntax tree so there are no openings
for [cross-site scripting (XSS)][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
See [contributing.md][contributing] in [syntax-tree/.github][health] forsupport.md`][support] for ways to get help.
ways to get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/syntax-tree/hast-util-embedded/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/hast-util-embedded/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-embedded.svg
[coverage]: https://codecov.io/github/syntax-tree/hast-util-embedded
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-embedded.svg
[downloads]: https://www.npmjs.com/package/hast-util-embedded
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-embedded
[size]: https://bundlejs.com/?q=hast-util-embedded
[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/syntax-tree/unist/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[license]: license
[author]: https://wooorm.com
[health]: https://github.com/syntax-tree/.github
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[spec]: https://html.spec.whatwg.org/multipage/dom.html#embedded-content-2
[hast]: https://github.com/syntax-tree/hast
[node]: https://github.com/syntax-tree/hast#nodes
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[api-embedded]: #embeddedvalue