Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not enough space between the links in the "on this page" navigation #82

Closed
Tracked by #72
gabalafou opened this issue May 28, 2024 · 6 comments
Closed
Tracked by #72
Assignees
Labels

Comments

@gabalafou
Copy link
Contributor

No description provided.

@gabalafou
Copy link
Contributor Author

gabalafou commented May 28, 2024

I don't need a Figma to implement this, but I think it would be great if somebody in design could tell me by exactly how much I should increase the space between the links, and then I'll implement it.

@gabalafou gabalafou changed the title Not enough space between the links in the "on this page" navigation [S] Not enough space between the links in the "on this page" navigation May 28, 2024
@gabalafou gabalafou moved this from 📬 TODO to Design in czi-scientific-python 🐍 May 31, 2024
@gabalafou gabalafou added the size: S A few hours, less than one week label May 31, 2024
@gabalafou gabalafou changed the title [S] Not enough space between the links in the "on this page" navigation Not enough space between the links in the "on this page" navigation May 31, 2024
@isabela-pf isabela-pf self-assigned this May 31, 2024
@isabela-pf isabela-pf moved this from Design to 🏗 In progress in czi-scientific-python 🐍 Jun 3, 2024
@isabela-pf
Copy link

Too long; didn't read: I would recommend we implement an additional 15 CSS pixels between the “On this page” navigation links. My rationale is in the paragraphs below the divider.


For context, my rationale overlaps with what I’ve already explained in #81. To summarize

  • I'm not aware of any WCAG 2.2 standards about spacing between buttons or another recommendation for spacing.
  • I am referencing is WCAG 2.5.8 Target Size as the nearest tested and trustworthy information.
  • I am extending WCAG 2.5.8 Target Size’s specifics to create criteria deciding what “enough space” between buttons will mean to us: when rounding the target size from corner to corner, this ellipse cannot overlap with the ellipse of any surrounding target size ellipse.

The main concern I have with the “On this page” navigation links is actually that I can’t find any space between clickable targets between the navigation list items (unlike the navbar buttons in #81 where there was still some non-clickable space between to start). When I move my cursor vertically, I cannot rest it anywhere between the list items and not have something hovered.

Example On this page menu as it currently appears in the PyData Sphinx Theme On this page menu with the Firefox Inspector tool showing the target size to be about 231pxs wide and 27pxs tall.

Target sizes this tightly packed require a lot of motor skill precision to work as expected and make it very easy to misclick.

When testing the overlap, I see about an equal number of pixels to the height of the target size overlapping, or about 27 CSS px. This makes sense to me considering the list items are almost back to back without spacing.

On this page menu with ellipses connecting the target corners to show how close they are together.

Because I’m already extending a guideline beyond its original scope, the length of the buttons with the short height require tall ellipses, and I am aware of many buttons with less than their own height between them that are considered to have good spacing, I am fine adding a fraction of this overlap. I think adding ~15 CSS px spacing between “On this page” list items adds spacing and leaves about a default cursor height’s space to rest.

@isabela-pf isabela-pf moved this from 🏗 In progress to 👀 In review in czi-scientific-python 🐍 Aug 1, 2024
@gabalafou
Copy link
Contributor Author

Thanks @isabela-pf, I'm going to take over from here and move this from design to dev

@gabalafou gabalafou moved this from 👀 In review to 🏗 In progress in czi-scientific-python 🐍 Aug 8, 2024
@gabalafou gabalafou assigned gabalafou and unassigned isabela-pf Aug 8, 2024
@gabalafou
Copy link
Contributor Author

@isabela-pf, your suggestion for the on-this-page navigation makes sense to me, but when I implement what I think you're asking, the result makes the right sidebar table of contents no longer look in harmony with the left sidebar table of contents. Did I implement this incorrectly or do we need to think about adjusting the spacing for other navigation areas?

@isabela-pf
Copy link

Good question! We talked about it in the #117 today and I'll be summarizing what we discussed here:

  • I didn't actually compare it to the left sidebar when I was examining it, so I didn't know whether it would match or not. This was on me.
  • When we checked again, the left sidebar actually has the same experience of no non-clickable space between navigation.
  • We agreed the wisest decision moving forward would be to make the spacing on the both of these match even if it is tight. Having a common experience—and, if needed in the future, changing them both to have more space—seems higher priority and better for having to solve less unique problems. @gabalafou is carrying on with this for now.

@gabalafou
Copy link
Contributor Author

Closing because pydata/pydata-sphinx-theme#1980 was merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

No branches or pull requests

3 participants