Skip to main content

required-h1

Warn if there is no h1 element in the document.

This rule is based on Techniques H42 for Success Criterion 1.3.1 in WCAG, Practices for skipping heading level and Web Accessibility Tutorials - Headings.

❌ Examples of incorrect code for this rule

<html>
<head>
<title>page</title>
</head>
<body>
<main>
<p>text</p>
</main>
</body>
</html>

✅ Examples of correct code for this rule

<html>
<head>
<title>page</title>
</head>
<body>
<main>
<h1>heading</h1>
<p>text</p>
</main>
</body>
</html>

Interface

{
"required-h1": boolean
}

Options

{
"required-h1": {
"options": {
"expected-once"?: boolean
"in-document-fragment"?: boolean
}
}
}
PropertyTypeDefault ValueDescription
expected-onceboolean"true"Warn if there is a duplicate h1 tag in the document.
in-document-fragmentboolean"false"Set it to true if you want this rule to apply within document fragment rather than the entire document.

Default Severity

error