-
Notifications
You must be signed in to change notification settings - Fork 43
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
- Web docs (HDS-3807)
#2410
base: hds-3800-app-sidenav-component
Are you sure you want to change the base?
AppSideNav
- Web docs (HDS-3807)
#2410
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
f2dd98b
to
7964b7d
Compare
9ffac4b
to
f5a98ed
Compare
024aca1
to
4db2dcf
Compare
f5a98ed
to
90c317b
Compare
c1e5dc6
to
d104760
Compare
AppSideNav
- web docs (HDS-3807)AppSideNav
- web docs (HDS-3807)
6506490
to
1636cbb
Compare
aae4586
to
e796a0d
Compare
9f512e0
to
22d61f6
Compare
AppSideNav
- web docs (HDS-3807)AppSideNav
- web docs sub-branch (HDS-3807)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Mostly left comments around alt text.
@@ -0,0 +1,5 @@ | |||
## 4.10.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: this will need to be updated to the correct version number
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/app-side-nav/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
- `isDesktop` | ||
- `isMinimized` | ||
|
||
![Schema of the different visual states in response to the change of viewports and the corresponding logic variables](/assets/components/app-side-nav/responsiveness.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I think it would be better to try and get more of this information out of the image and into the page. Maybe a table with the images and captions describing each state?
|
||
#### `aria` attributes | ||
|
||
The App Side Nav component already provides some of the required `aria` attributes. But other attributes are needed when declaring its content. Please refer to the [Accessibility](/components/app-side-nav?tab=accessibility) section for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: There isn't really anything in the a11y tab describing what attributes are needed when declaring the content. Can you specify here?
website/docs/components/app-side-nav/partials/specifications/anatomy.md
Outdated
Show resolved
Hide resolved
AppSideNav
- web docs sub-branch (HDS-3807)AppSideNav
- Web docs (HDS-3807)
Thanks for all of your detailed suggestions @shleewhite ! I think I caught everything pertaining to the guidelines and the anatomy. |
TODO for KB:
📌 Summary
If merged, this PR will add documentation for the
AppSideNav
to HDS.Preview: https://hds-website-git-hds-3807-app-sidenav-docs-hashicorp.vercel.app/components/app-side-nav
Related branches:
AddSide
Component:AppSideNav
- Component branch (HDS-3800) #2384SideNav
Deprecation:SideNav
- Deprecate component (HDS-3848) #2425🔗 External links
👀 Component checklist
[ ] Percy was checked for any visual regression[ ] A changelog entry was added via Changesets if needed (see templates here)💬 Please consider using conventional comments when reviewing this PR.