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

AppSideNav - Component branch (HDS-3800) #2384

Open
wants to merge 67 commits into
base: main
Choose a base branch
from

Conversation

KristinLBradley
Copy link
Contributor

@KristinLBradley KristinLBradley commented Sep 3, 2024

STATUS: PR has been approved.


📌 Summary

If merged, this PR will add the AppSideNav component to HDS & deprecate the SideNav.

Previews:

🛠️ Detailed description

The majority of code was duplicated from the SideNav and then modified to implement the new AppSideNav component.

Major differences of note:

  • The AppSideNav has an updated visual design using lighter colors than the SideNav
    • Dark theme styles are no longer added to nested Button & Dropdown components
  • The AppSideNav structure was simplified:
    • Structural named blocks were removed: :header, :footer, :body, :root
    • The :logo & :actions child named blocks were removed (used in old :header)
    • The Header and Header::HomeLink child components were removed.
  • The Navigator Narrator (skip link) was removed as the AppSideNav is meant to always be paired with the AppHeader which already includes this
  • Bug with overflow scrolling was fixed (caused by navigating from panel with long content to panel with short content)

(Spike of restructured List and ListTitle which may be explored in later iterations)

(Internal references: RFC, Meta CRD)

🔗 External links


👀 Component checklist

💬 Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Sep 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Oct 17, 2024 6:14pm
hds-website ✅ Ready (Inspect) Visit Preview Oct 17, 2024 6:14pm

Copy link
Member

@alex-ju alex-ju left a comment

Choose a reason for hiding this comment

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

Individual changes were reviewed in separate PRs. I would suggest rebasing this PR to main to resolve the one conflict highlighted in the website docs around the deprecation badge.

Copy link
Contributor

@zamoore zamoore left a comment

Choose a reason for hiding this comment

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

Really clean code and good tests. I know this has been a journey, but I think this is very good work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website packages/components packages/tokens showcase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants