Documentation
Learn how Polypane improves your workflow
Outline Panel
The "Outline" tab in the Info panel shows you the page structure in various ways: by headings, landmarks, links, images, focus order or accessibility tree. These outlines are used by assistive technologies to allow users to go through your page quickly.
You can switch between different outlines using the dropdown in the top right, and check or uncheck "show issues" to show just the list or suggest improvements as well. The outlines are updated live on changes to the page, though you can forcibly refetch data with the reload icon in the top left.
Hover over any of the elements to scroll them into view on all panes and show a tooltip with their element info. Clicking on the element will open it in the Polypane element panel. Read on for more information on each outline.
Polypane is filled with accessibility features. We wrote a full overview on our blog: Find and fix accessibility issues with Polypane.
Headings
Shows all the headings and ARIA headings currently on the page. The overview will warn you when it finds the following issues:
- The page has more than one H1.
- The page has no H1.
- Heading levels are skipped.
- Headings with duplicate content, missing content or hidden content.
- Headings with overly long content.
- Using aria heading levels beyond 6 (which is not recommended) and 9 (which is not supported).
- When the accessible name and visual name are too different (WCAG SC 2.5.3).
- When the accessible name has repeating substrings.
None of these are strict WCAG failures or spec violations but they are considered best practices. It will also highlight headings that are presentational, hidden and where the text content is different from the accessible name.
To get a visual overview inside the panes, click "Show overlay". This will draw boxes around all headers and display any issues, which will also be visible in the screenshots you make.
Landmarks
This will show all HTML 5 and ARIA landmark elements on the page and display them with the appropriate role. Polypane will warn you if there are issues with your landmarks, such as:
- Duplicate landmarks,
- Missing landmarks,
- Unnecessary labels
- Incorrect nesting
When you check the 'show potentials' option in the top right, Polypane will also show landmark-like elements in the overview and the overlay and explain why they aren't added to the list of landmarks properly.
If you want to learn more about how these landmark rules work exactly, check out landmarks and where to put them, which Kilian wrote for the HTMHell advent calendar.
To get a visual overview inside the panes, click "Show overlay". This will draw boxes around all landmarks and display any issues, which will also be visible in the screenshots you make.
Links
Shows a list of links (both a
elements with an href
attribute, and elements with role=link
set). If an element has a target
, hreflang
or title
that will be displayed, and the overview will warn you if there is no text, duplicate content in the title
or a missing aria-current
attribute.
Additionally, a badge will be shown for any non-https links, for empty href
attributes and for links that have a placeholder value like mailto:
. When a link has non-descriptive text, like "click here" or "more", we show a warning. External links are given an icon indicating they leave the website.
To get a visual overview inside the panes, click "Show overlay". This will draw boxes around all links and display any issues, which will also be visible in the screenshots you make.
Broken link checking
If the links panel is opened or switched to, Polypane will automatically test all the URLS in the page and highlight broken urls or urls with redirects unless you have more than 100 links. In that case, you need to click "Check status" button to test them, so you don't unintentionally overload your server.
Document fragment links (starting with #
) will be checked by testing if the referenced element ID exists on the page. Alternate protocols like mailto:
and tel:
are skipped.
Not all sites support testing URLs and some will send error codes back indicating this. The appropriate error code for this is 405 Method Not Allowed
, or 429 Too Many Requests
if you have a lot of URLs going to one origin. When that happens Polypane will show a question mark to indicate you need to manually check these.
There are also sites that send back alternative error codes like 400, 999 and 503. This isn't a clear indication so we show the error code as-is.
Learn more: How to find broken links with Polypane
Additional warnings
Polypane also warns you about inaccessible links, incorrect use of anchor (#
) links and for missing accessible text.
We also check the accessible name of the link for the following issues:
- When the accessible name and visual name are too different (WCAG SC 2.5.3).
- When the accessible name has repeating substrings.
When Polypane encounters multiple links with the same URL but different text content, or multiple links with the same text content but different URLs, it will show a warning and a list of the mismatched links.
Images
Shows all the images that are currently visible on the page, with a preview, their current source, alt
attribute, title, dimensions, file size, aspect ratio and actual dimensions when the image isn't displayed at full size.
Image files that can't be found as well as any other issues with the image are highlighted with a warning.
You can right-click a preview to save the image to disk or copy the image location.
To get a visual overview inside the panes, click "Show overlay". This will draw boxes around all images and display any issues, which will also be visible in the screenshots you make.
Alt attributes
If the alt
attribute is missing a warning is shown. An alt
attribute that is present but empty is seen as intentional so will not show an issue.
For alt
attributes that contain redundant or nondescriptive text, like Emoij's, "A photo of", a color like "a green button", the text "alt" or "placeholder" or repeats the file name we show a warning.
alt texts that are too long can be tedious, so Polypane also shows a warning when it detect long descriptions.
Focus order (Tab order)
Will show you all focusable elements in the order that they are focused when pressing the tab button, along with any tabindex
and autofocus
attributes.
When it finds elements that are not focusable/interactive by default but have been made focusable, Polypane will suggest changing them to a native interactive element instead. It also gives a warning when you use positive numbers for tabindex
, which are best avoided. It highlights focus stops that go against the reading direction.
To get a visual overview, click "Show overlay". This will draw a focus trial along all the focusable elements. Numbers shown in red are elements that go against the reading direction of the page.
Keeping track of the focused element
When you page has an element with focus, that element is indicated in the Focus order list with an arrow in front of the item, and de the list automatically scrolls to move the focused element into view.
When the overlay is active, it also shows the currently focused element by filling the dot in blue.
Accessibility tree
The accessibility tree is similar to the DOM (it's also called the AOM, Accessibility Object Model), but the rendering engine builds it up for assistive technology like screen readers who take the accessibility tree and use that to present the page to the user.
In the accessibility tree you will find all the relevant elements and their information: role, name, description, state, properties, and children. Polypane will warn you when there are issues with the accessibility tree, like missing roles, missing names, or elements with names that shouldn't have them.
For elements linked by aria-controls
, Polypane will check that the linked IDs are in the DOM and give a warning if they're missing.
Generic roles
By default, Polypane hides all elements with generic roles. This makes the accessibility tree easier to navigate (since you don't have to click through any nested div
elements). You can show the generic roles by checking the "Show generic roles" option.
Showing generic roles is useful to verify that all the elements you expect to be in the accessibility tree are. If an element doesn't show up but you expect it to be, showing generics will let you inspect why.
Have a question about Polypane?
Contact us any time though chat, Slack or our contact form:
Contact SupportBuild your next project with Polypane
- Use all features on all plans
- On Mac, Window and Linux
- 14-day free trial – no credit card needed