Skip to content

utility to check if a node is a sectioning element

License

Notifications You must be signed in to change notification settings

syntax-tree/hast-util-sectioning

Repository files navigation

hast-util-sectioning

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to check if a node is sectioning content.

Contents

What is this?

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

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

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

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

sectioning({
  type: 'element',
  tagName: 'article',
  properties: {},
  children: [
    {
      type: 'element',
      tagName: 'p',
      properties: {},
      children: [{type: 'text', value: 'Delta'}]
    }
  ]
}) // => true

API

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

sectioning(value)

Check if the given value is a sectioning content.

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

Whether value is an element considered sectioning content.

The elements article, aside, nav, and section are sectioning.

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

Security

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

Related

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