hast-util-labelable

hast utility to check if an element is labelable.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install hast-util-labelable

Use

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

API

This package exports the following identifiers: labelable. There is no default export.

labelable(node)

Check if the given value is a labelable element.

Parameters

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

Returns

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

Security

hast-util-labelable 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) 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

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.

License

MIT © Titus Wormer