Skip to content

Mainframe: Sidebar implemtation #245

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

Merged
merged 12 commits into from
May 8, 2025
Merged

Mainframe: Sidebar implemtation #245

merged 12 commits into from
May 8, 2025

Conversation

nginx-jack
Copy link
Collaborator

@nginx-jack nginx-jack commented May 7, 2025

This is a from scratch sidebar implementation iterating on @danielledeleo branch and design feedback.

It should work like a sidebar, as expected 🤞 .
Takes the toc frontmatter into account, to render or not render the table of contents.

Product selector and search are removed from the sidebar. The search now lives in the header, and the product selector will likely end up there as well, but it's not part of this PR.

The table of contents is within the sidebar still, and can be hidden/shown.
There are two a11y hidden links for skipping the sidebar entirely, or just skipping the table of contents you're on.
There's also a fix in here for icons, so that they resize properly via css.

I'd like to get this merged with it's current feature set, but there are some TODOs for future PRs:

  • Add an overview page nodes that have content in their _index.md file. This is important, since you can no longer click directly on a node with pages to see a "list" view.
  • Try to make the green hover/selected background spread across the full width of the sidebar. Fought with CSS for a while, but had to call it!

a11y skipper for table of contents

For users
Screenshot 2025-05-07 at 16 07 47

a11y skipper for entire sidebar

Screenshot 2025-05-07 at 16 07 31

Screenshots of various states below

Screenshot 2025-05-07 at 16 07 25 Screenshot 2025-05-07 at 16 07 03 Screenshot 2025-05-07 at 16 06 54 Screenshot 2025-05-07 at 16 06 46

@nginx-jack nginx-jack requested a review from a team as a code owner May 7, 2025 16:04
@nginx-jack nginx-jack changed the title Mainframe: Sidebar implentation Mainframe: Sidebar implemtation May 7, 2025
Copy link
Collaborator

@lamATnginx lamATnginx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks great and makes sense. UI looks good.

@lamATnginx lamATnginx mentioned this pull request May 7, 2025
4 tasks
@nginx-jack nginx-jack merged commit 4da9c2e into main May 8, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants