Hast-util-labelable NPM

hast-util-labelable

hast utility to check if a node is a labelable element.

What is this?

This package is a small utility that checks if a node is a labelable element 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-labelable

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

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

labelable({type: 'element', tagName: 'div', properties: {}, children: []}) // => false

labelable({type: 'element', tagName: 'input', properties: {}, children: []}) // => true

labelable({
  type: 'element',
  tagName: 'input',
  properties: {type: 'hidden'},
  children: []
}) // => false

API

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

`labelable(node)`

Check if the given value is a labelable element.

Parameters

node (Node) — node to check (typically Element)

Returns

Whether node is a labelable element (boolean).

Labelable elements are button, input (excluding [type=hidden]), keygen, meter, output, progress, select, and textarea.

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-labelable@^3, compatible with Node.js 16.