hast-util-heading

hast utility to check if a node is a heading content element.

Contents

• When should I use this?
• Install
• Use
• API
  • heading(value)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

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-heading

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

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

// Given a non-heading value:
heading({
  type: 'element',
  tagName: 'a',
  properties: {href: '#alpha', title: 'Bravo'},
  children: [{type: 'text', value: 'Charlie'}]
}) // => false

// Given a heading element:
heading({
  type: 'element',
  tagName: 'h1',
  properties: {},
  children: [{type: 'text', value: 'Delta'}]
}) // => true

API

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

heading(value)

Check if the given value is a heading content element.

Parameters

• value (unknown) — thing to check (typically Node)

Returns

Whether value is a heading content element (boolean).

The elements h1, h2, h3, h4, h5, h6, and hgroup are heading content.

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

Security

hast-util-heading does not change the syntax tree so there are no openings for cross-site scripting (XSS) attacks.

Related

• hast-util-heading-rank — get the rank (or depth, level) of headings
• hast-util-shift-heading — change the rank (or depth, level) of headings
• 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-interactive — check if a node is interactive
• hast-util-is-javascript — check if a node is a JavaScript script element
• hast-util-labelable — check whether a node is labelable
• 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