hast-util-heading
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechathast utility to check if a node is a heading content elementspec.
Contents
* [`heading(value)`](#headingvalue)
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 onlyesm. In Node.js (version 16+), install with npm:npm install hast-util-heading
In Deno with
esm.sh
esmsh:import {heading} from 'https://esm.sh/hast-util-heading@3'
In browsers with
esm.sh
esmsh:<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 identifierheading
api-heading.
There is no default export.heading(value)
Check if the given value is a heading content elementspec.Parameters
value
(unknown
)
— thing to check (typically [`Node`][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)xss attacks.Related
— get the rank (or depth, level) of headings
— change the rank (or depth, level) of headings
— check if a node is a (certain) element
— check if a node has a property
— check if a node is “Body OK” link element
— check if a node is a conditional comment
— check if a node is a CSS link element
— check if a node is a CSS style element
— check if a node is an embedded element
— check if a node is interactive
— check if a node is a JavaScript script element
— check whether a node is labelable
— check if a node is phrasing content
— check if a node is a script-supporting element
— check if a node is a sectioning element
— check if a node is a transparent element
— check if a node is inter-element whitespace
Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.