Headings check escapes confinement

Created on 16 April 2025, 10 days ago

Problem/Motivation

The Headings check seems to be escaping the confinement of specified checking containers. I noticed thin testing, as with our current branding, we have the site name as an H2 in our footer element which is outside of the main element we restrict Editoria11y to.

If this is by design, that's fine; I can set an ignore rule, since while site managers can change the site name, they cannot control how it is displayed.

Steps to reproduce

  1. Setup Editoria11y to scan a container
  2. Have a heading in another container on the same level

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

πŸ› Bug report
Status

Active

Version

2.2

Component

Bugs

Created by

πŸ‡ΊπŸ‡ΈUnited States R_H-L

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @R_H-L
  • πŸ‡ΊπŸ‡ΈUnited States itmaybejj

    Is it flagging things as errors outside the specified check areas, or just showing other headings in the little visualizer?

    What I am trying to do at the moment is have the page outline visualizer ignore the check roots and show all headings, but for errors in headings to only be flagged if they are within the specified check roots. But that means I'm running the same DOM dive two different ways and have to keep track of which tree I'm using at all times, so errors on my own part would not be surprising...

  • πŸ‡ΊπŸ‡ΈUnited States R_H-L

    I wasn't seeing anything for errors outside of the specified container, I just worry it may be confusing for some users to see headings tagged outside of their control, and wanted to make sure it was by design.

  • πŸ‡ΊπŸ‡ΈUnited States itmaybejj

    Fair enough. The functionality is by design, but maybe I should revisit the design in a future iteration so there is a visual distinction between the editable headings and the template headings. Though in a lot of contexts I just won't know which it is; there are often a lot of template headings within the editable area.

  • πŸ‡ΊπŸ‡ΈUnited States R_H-L

    Keeping it as is I think is fine, just making a note someplace in documentation, though this issue may also take care of that. It's not hard to put in some simple ignores if needed.

Production build 0.71.5 2024