Accessibility: Use proper semantic HTML

Open
#81 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
html, react, typescript
Domain
accessibility, frontend, web-dev

Research direction

Locate the React components that render the item pages and inspect the current heading, subtitle, description, and keyboard-binding tooltip markup. Update the structure so each page has an h1 for the item name and valid semantic elements for the remaining text, then verify multi-line descriptions and tooltips remain visually correct and accessible.

Written by the indexing model from the issue text.

Description

enhancement

Issue

On the item pages, the name, subtitle and description are all heading tags.

Subtitle and Description are not headings.

Also these pages do not have an h1.

Suggestion

Use h1 for the item name.
Use a <p> or <div> tag with font-size: 1.6rem as subtitle.
Use a <p> tag with font-size: 1rem as description.
For multi-line descriptions, use <span> with display: block to emulate a <div>, while conforming to the HTML spec.
The tooltips on the keyboard bindings can probably also be done with <span>.
Elements like <div> and <p> are not permitted inside <p> itself.

See Content Categories on MDN

Here's an example of what I mean:
html_mockup

Dominant language
TypeScript
Stars
20
Forks
2
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AssistantNMS/WebApp

All issues in AssistantNMS/WebApp

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.