Awesome
hast-util-heading
hast utility to check if a node is a heading content element.
Contents
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 (typicallyNode
)
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 headingshast-util-shift-heading
— change the rank (or depth, level) of headingshast-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-interactive
— check if a node is interactivehast-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.