tc39 / tc39/ecmarkup

The toolbox and grammars don't mesh well

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
245
Forks
80
Avg merge
10h 46m
Merged PRs (30d)
2

Description

While reading, I can sometimes follow along with the mouse cursor just under the line I'm trying to read. It happens mechanically, unconsciously, especially when I'm tired.

If you do that while reading grammars, you end up with the toolbox covering what you are trying to read, which is suboptimal.

It may even be an a11y concern for dyslexic folks. Likewise, the grey box on hover seems more distracting than useful.

https://github.com/tc39/ecmarkup/pull/154 lets one dismiss it with "esc", but it is a one shot solution, and it is not discoverable (unless one happens to be scouring the GH issues about the tooltip).

It would be IMO better to have a small, dedicated hover box on the left side of each rule. You could highlight it slightly when the corresponding line is hovered, thus giving a visual cue that it is interactive.

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.

Research direction

Start by reviewing the current toolbox and grammar hover behavior, along with tc39/ecmarkup#154 and the linked grammar example. Done should mean the interaction no longer covers the grammar being read, provides a discoverable dedicated hover control on the rule's left side, and offers a clear visual cue when the rule is hovered.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
accessibility, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.