Awesome
hast-util-interactive
hast utility to check if a node is interactive content.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package is a small utility that checks if a node is interactive 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 16+), install with npm:
npm install hast-util-interactive
In Deno with esm.sh
:
import {interactive} from 'https://esm.sh/hast-util-interactive@3'
In browsers with esm.sh
:
<script type="module">
import {interactive} from 'https://esm.sh/hast-util-interactive@3?bundle'
</script>
Use
import {interactive} from 'hast-util-interactive'
interactive({
type: 'element',
tagName: 'a',
properties: {},
children: []
}) // => false
interactive({
type: 'element',
tagName: 'a',
properties: {href: '#alpha'},
children: []
}) // => true
interactive({
type: 'element',
tagName: 'video',
properties: {controls: true},
children: []
}) // => true
API
This package exports the identifier interactive
.
There is no default export.
interactive(node)
Check if the given value is interactive content.
Parameters
node
(Node
, optional) — node to check
Returns
Whether node
is an Element
that is classified as interactive
content (boolean
).
The following elements are interactive:
a
withhref
audio
orvideo
withcontrols
img
orobject
withuseMap
input
withouthidden
- any element with a
tabIndex
- the elements
button
,details
,embed
,iframe
,keygen
,label
,select
, andtextarea
Types
This package is fully typed with TypeScript. It exports no additional types.
Compatibility
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-interactive@^3
,
compatible with Node.js 16.
Security
hast-util-interactive
does not change the syntax tree so there are no openings
for cross-site scripting (XSS) attacks.
Related
hast-util-is-element
— check if a node is a (certain) elementhast-util-has-property
— check if a node has a propertyhast-util-is-body-ok-link
— check if a node is “Body OK” link elementhast-util-is-conditional-comment
— check if a node is a conditional commenthast-util-is-css-link
— check if a node is a CSS link elementhast-util-is-css-style
— check if a node is a CSS style elementhast-util-embedded
— check if a node is an embedded elementhast-util-heading
— check if a node is a heading elementhast-util-is-javascript
— check if a node is a JavaScript script elementhast-util-labelable
— check whether a node is labelablehast-util-phrasing
— check if a node is phrasing contenthast-util-script-supporting
— check if a node is a script-supporting elementhast-util-sectioning
— check if a node is a sectioning elementhast-util-transparent
— check if a node is a transparent elementhast-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.