sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
149 lines
4.9 KiB
Markdown
149 lines
4.9 KiB
Markdown
# 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**][hast] utility to check if an [*element*][element] is
|
|
[*embedded*][spec].
|
|
|
|
## Install
|
|
|
|
[npm][]:
|
|
|
|
```sh
|
|
npm install hast-util-embedded
|
|
```
|
|
|
|
## Use
|
|
|
|
```js
|
|
var embedded = require('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
|
|
|
|
### `embedded(node)`
|
|
|
|
Check if `node` is an [*embedded*][spec] [*element*][element].
|
|
|
|
## Security
|
|
|
|
`hast-util-embedded` does not change the syntax tree so there are no openings
|
|
for [cross-site scripting (XSS)][xss] attacks.
|
|
|
|
## Related
|
|
|
|
* [`hast-util-is-element`](https://github.com/syntax-tree/hast-util-is-element)
|
|
— check if a node is a (certain) element
|
|
* [`hast-util-has-property`](https://github.com/syntax-tree/hast-util-has-property)
|
|
— check if a node has a property
|
|
* [`hast-util-is-body-ok-link`](https://github.com/rehypejs/rehype-minify/tree/HEAD/packages/hast-util-is-body-ok-link)
|
|
— check if a node is “Body OK” link element
|
|
* [`hast-util-is-conditional-comment`](https://github.com/rehypejs/rehype-minify/tree/HEAD/packages/hast-util-is-conditional-comment)
|
|
— check if a node is a conditional comment
|
|
* [`hast-util-is-css-link`](https://github.com/rehypejs/rehype-minify/tree/HEAD/packages/hast-util-is-css-link)
|
|
— check if a node is a CSS link element
|
|
* [`hast-util-is-css-style`](https://github.com/rehypejs/rehype-minify/tree/HEAD/packages/hast-util-is-css-style)
|
|
— check if a node is a CSS style element
|
|
* [`hast-util-heading`](https://github.com/syntax-tree/hast-util-heading)
|
|
— check if a node is a heading element
|
|
* [`hast-util-interactive`](https://github.com/syntax-tree/hast-util-interactive)
|
|
— check if a node is interactive
|
|
* [`hast-util-is-javascript`](https://github.com/rehypejs/rehype-minify/tree/HEAD/packages/hast-util-is-javascript)
|
|
— check if a node is a JavaScript script element
|
|
* [`hast-util-labelable`](https://github.com/syntax-tree/hast-util-labelable)
|
|
— check whether a node is labelable
|
|
* [`hast-util-phrasing`](https://github.com/syntax-tree/hast-util-phrasing)
|
|
— check if a node is phrasing content
|
|
* [`hast-util-script-supporting`](https://github.com/syntax-tree/hast-util-script-supporting)
|
|
— check if a node is a script-supporting element
|
|
* [`hast-util-sectioning`](https://github.com/syntax-tree/hast-util-sectioning)
|
|
— check if a node is a sectioning element
|
|
* [`hast-util-transparent`](https://github.com/syntax-tree/hast-util-transparent)
|
|
— check if a node is a transparent element
|
|
* [`hast-util-whitespace`](https://github.com/syntax-tree/hast-util-whitespace)
|
|
— check if a node is inter-element whitespace
|
|
|
|
## Contribute
|
|
|
|
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
|
|
started.
|
|
See [`support.md`][support] for ways to get help.
|
|
|
|
This project has a [code of conduct][coc].
|
|
By interacting with this repository, organization, or community you agree to
|
|
abide by its terms.
|
|
|
|
## License
|
|
|
|
[MIT][license] © [Titus Wormer][author]
|
|
|
|
<!-- Definition -->
|
|
|
|
[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/bundlephobia/minzip/hast-util-embedded.svg
|
|
|
|
[size]: https://bundlephobia.com/result?p=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
|
|
|
|
[license]: license
|
|
|
|
[author]: https://wooorm.com
|
|
|
|
[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
|
|
|
|
[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
|
|
|
|
[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
|
|
|
|
[spec]: https://html.spec.whatwg.org/#embedded-content-2
|
|
|
|
[hast]: https://github.com/syntax-tree/hast
|
|
|
|
[element]: https://github.com/syntax-tree/hast#element
|
|
|
|
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
|