HTML Formatting issues #9788

Closed
opened 2025-12-29 21:22:39 +01:00 by adam · 2 comments
Owner

Originally created by @andrewgormley on GitHub (Jun 3, 2024).

Originally assigned to: @andrewgormley on GitHub.

NetBox version

v4.0.3

Feature type

Change to existing functionality

Proposed functionality

Fix HTML formatting and best practise issues across the app that were found using Google Lighthouse and WAVE.

Format:
(Location) Issue [Occurrences]

  • (Misc) [user-scalable="no" in the meta tag [Global]
  • (Misc) Lists do not contain only li elements [Multiple]
  • (Misc) Form elements without effective labels [Multiple]
  • (Misc) Heading elements not in sequential descending order (h5 sub-header) [Multiple]
  • (Misc) Edit icon/combo box missing alt text [Multiple]
  • (Misc) Checkbox missing label [Multiple]
  • (Misc) Missing link text on hidden table column [Multiple]
  • (Dashboard) module actions missing text [Single]
  • (Footer) missing link text [Global]
  • (User profile) redundant link as both id and date link to the same place [Single]
  • (Tables) unlabelled column header for checkbox column [Multiple]
  • (Add token) broken aria references [Multiple]
  • (Tables) missing aria label on quick search box [Multiple]
  • (Progress bars) do not have accessible aira labels [Multiple]
  • (Racks) Rack elevation objects missing alt text [Multiple]
  • (Racks) 'images and labels' button label is ambiguous [Multiple]
  • (Tables) Ensure tables use table and row headers to describe cells [Multiple]
  • (Tables) row actions missing accessible names [Multiple]
  • (New object) aira broken on slug combo box [Multiple]
  • (New object) aira broken on input description text [Multiple]
  • (Misc) Info hotspot missing link text [Multiple]
  • (Tables) when table column is sorted the 'x' icon is missing link text [Multiple]
  • (Configure table) some buttons are skipped when tabbing through the modal [Multiple]
  • (Buttons) On rack elevation page front and rear toggle button missing focus state on active part [Multiple]
  • (Misc) When categorising objects by colour, we should have the colour name in the label or on hover [Multiple]

Use case

An accessibility audit revealed many issues with the current application. The above changes will address HTML formatting issues, fixing these issues will ensure that users utilising screen readers and other accessibility tools will come across less issues.

Database changes

No response

External dependencies

No response

Originally created by @andrewgormley on GitHub (Jun 3, 2024). Originally assigned to: @andrewgormley on GitHub. ### NetBox version v4.0.3 ### Feature type Change to existing functionality ### Proposed functionality Fix HTML formatting and best practise issues across the app that were found using Google Lighthouse and WAVE. Format: (Location) Issue [Occurrences] - [ ] (Misc) [user-scalable="no" in the meta tag [Global] - [ ] (Misc) Lists do not contain only li elements [Multiple] - [ ] (Misc) Form elements without effective labels [Multiple] - [ ] (Misc) Heading elements not in sequential descending order (h5 sub-header) [Multiple] - [ ] (Misc) Edit icon/combo box missing alt text [Multiple] - [ ] (Misc) Checkbox missing label [Multiple] - [ ] (Misc) Missing link text on hidden table column [Multiple] - [ ] (Dashboard) module actions missing text [Single] - [ ] (Footer) missing link text [Global] - [ ] (User profile) redundant link as both id and date link to the same place [Single] - [ ] (Tables) unlabelled column header for checkbox column [Multiple] - [ ] (Add token) broken aria references [Multiple] - [ ] (Tables) missing aria label on quick search box [Multiple] - [ ] (Progress bars) do not have accessible aira labels [Multiple] - [ ] (Racks) Rack elevation objects missing alt text [Multiple] - [ ] (Racks) 'images and labels' button label is ambiguous [Multiple] - [ ] (Tables) Ensure tables use table and row headers to describe cells [Multiple] - [ ] (Tables) row actions missing accessible names [Multiple] - [ ] (New object) aira broken on slug combo box [Multiple] - [ ] (New object) aira broken on input description text [Multiple] - [ ] (Misc) Info hotspot missing link text [Multiple] - [ ] (Tables) when table column is sorted the 'x' icon is missing link text [Multiple] - [ ] (Configure table) some buttons are skipped when tabbing through the modal [Multiple] - [ ] (Buttons) On rack elevation page front and rear toggle button missing focus state on active part [Multiple] - [ ] (Misc) When categorising objects by colour, we should have the colour name in the label or on hover [Multiple] ### Use case An accessibility audit revealed many issues with the current application. The above changes will address HTML formatting issues, fixing these issues will ensure that users utilising screen readers and other accessibility tools will come across less issues. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featurestatus: under review labels 2025-12-29 21:22:39 +01:00
adam closed this issue 2025-12-29 21:22:39 +01:00
Author
Owner

@jeremystretch commented on GitHub (Jun 4, 2024):

@andrewgormley thanks for compiling such a comprehensive list. I suspect some of these bullet points will expand into a fairly large number of shallow but broad changes. In order to ensure we can efficiently review the proposed changes in the form of pull requests, let's try to break this down into multiple issues that can be progressed individually. Some themes I see in the list above are:

  • Fixing accessibility controls (e.g. aria-* attributes)
  • Rack elevations
  • Table rendering
  • Missing form labels

Could you open a few new issues to track these work items separately? This should greatly reduce the burden of PR review and allow us to approve & merge changes more quickly. We can keep this issue open as a catch-all for anything that doesn't align with a theme (but these should be kept to a minimum). Thanks!

@jeremystretch commented on GitHub (Jun 4, 2024): @andrewgormley thanks for compiling such a comprehensive list. I suspect some of these bullet points will expand into a fairly large number of shallow but broad changes. In order to ensure we can efficiently review the proposed changes in the form of pull requests, let's try to break this down into multiple issues that can be progressed individually. Some themes I see in the list above are: - Fixing accessibility controls (e.g. `aria-*` attributes) - Rack elevations - Table rendering - Missing form labels Could you open a few new issues to track these work items separately? This should greatly reduce the burden of PR review and allow us to approve & merge changes more quickly. We can keep this issue open as a catch-all for anything that doesn't align with a theme (but these should be kept to a minimum). Thanks!
Author
Owner

@jeffgdotorg commented on GitHub (Jul 15, 2024):

This issue's tasks got folded up into others, closing as not planned

@jeffgdotorg commented on GitHub (Jul 15, 2024): This issue's tasks got folded up into others, closing as not planned
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9788