hast utility to check if a node is labelable.

• What is this?
• When should I use this?
• Install
• Use
• API
  • labelable(node)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a small utility that checks if a node is a labelable element 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. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install hast-util-labelable

In Deno with esm.sh:

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

In browsers with esm.sh:

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

import {labelable} from 'hast-util-labelable' labelable({type: 'element', tagName: 'div'}) // => false labelable({type: 'element', tagName: 'input'}) // => true labelable({ type: 'element', tagName: 'input', properties: {type: 'hidden'} }) // => false

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

Check if the given value is a labelable element.

• node (*, optional) — Value to check, probably Node

Whether node is a labelable element (boolean). Labelable nodes have a tagName set to button, keygen, meter, output, progress, select, textarea, and input (excluding [type=hidden]).

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

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

hast-util-labelable 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-embedded — check if a node is an embedded 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-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 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.

MIT © Titus Wormer