fix(theme): Doc sidebar links/categories with long labels should display properly #11356
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ [V2]
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Size Change: +128 kB (+1.11%) Total Size: 11.7 MB
ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
7 tasks
|
Size Change: +133 kB (+1.11%) Total Size: 12.1 MB
ℹ️ View Unchanged
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Fix #10531
Long sidebar labels should display properly for docs and categories items.
I choose to use
line-clamp: 2as a good default so that API references are not too short and items have a chance to wrap and break words even if they don't contain any space.The result looks good enough to me for most Docusaurus sites, although this is a personal opinion:
The CSS is easy to override to 1 if people prefer no line wrapping at all.
Hovering truncated long labels show a browser tooltip thanks to
title. This is not perfect for accessibility (doesn't show on keyboard nav or mobile/touch screens), but we already use that solution in other places, so we'll improve that later globally.Test Plan
CI + Argos visual regression tests
Test with/without CSS cascade layers enabled
Test links
https://deploy-preview-11356--docusaurus-2.netlify.app/tests/docs/tests/sidebar-display/Category1LongLongLongLongLongLongLongLongLongLong/doc2%20long%20long%20long%20long%20long%20long%20long%20long%20long%20long%20long%20long