Implement NavList component (part 1) #2058
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@primer/react": patch | ||
| --- | ||
|
|
||
| Add draft of `NavList` component |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,44 +2,30 @@ | |
| title: NavList | ||
| status: Draft | ||
| description: Use nav list to render a vertical list of navigation links. | ||
| source: https://github.com/primer/react/tree/main/src/NavList | ||
| --- | ||
|
|
||
| ```js | ||
| import {NavList} from '@primer/react/drafts' | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Simple | ||
|
|
||
| ```jsx live drafts | ||
| <NavList> | ||
| <NavList.Item href="/" aria-current="page"> | ||
| Home | ||
| </NavList.Item> | ||
| <NavList.Item href="/about">About</NavList.Item> | ||
| <NavList.Item href="/contact">Contact</NavList.Item> | ||
| </NavList> | ||
| ``` | ||
|
|
||
| ### With leading icons | ||
|
|
||
| ```jsx live drafts | ||
| <NavList> | ||
| <NavList.Item href="/" aria-current="page"> | ||
| <NavList.LeadingVisual> | ||
|
|
@@ -62,88 +48,34 @@ To render a horizontal list of navigation links, consider using [UnderlineNav](/ | |
| </NavList> | ||
| ``` | ||
|
|
||
| ### With other leading visuals | ||
|
|
||
| ```jsx live drafts | ||
| <NavList> | ||
| <NavList.Item href="/general" aria-current="page"> | ||
| <NavList.LeadingVisual> | ||
| <span aria-hidden>#️⃣</span> | ||
| </NavList.LeadingVisual> | ||
| General | ||
| </NavList.Item> | ||
| <NavList.Item href="/q-a"> | ||
| <NavList.LeadingVisual> | ||
| <span aria-hidden>🙏</span> | ||
| </NavList.LeadingVisual> | ||
| Q&A | ||
| </NavList.Item> | ||
| <NavList.Item href="/show-and-tell"> | ||
| <NavList.LeadingVisual> | ||
| <span aria-hidden>🙌</span> | ||
| </NavList.LeadingVisual> | ||
| Show and tell | ||
| </NavList.Item> | ||
| </NavList> | ||
| ``` | ||
|
|
||
| ### With trailing visuals | ||
|
|
||
| ```jsx live drafts | ||
| <NavList> | ||
| <NavList.Item href="/inbox" aria-current="page"> | ||
| Inbox | ||
|
|
@@ -154,31 +86,13 @@ To render a horizontal list of navigation links, consider using [UnderlineNav](/ | |
| </NavList> | ||
| ``` | ||
|
|
||
| ### With a heading | ||
|
|
||
| ```jsx live drafts | ||
| <> | ||
| <Heading as="h3" id="workflows-heading" sx={{fontSize: 2}}> | ||
| Workflows | ||
| </Heading> | ||
| <NavList aria-labelledby="workflows-heading"> | ||
| <NavList.Item href="/" aria-current="page"> | ||
| All workflows | ||
|
|
@@ -190,26 +104,9 @@ To render a horizontal list of navigation links, consider using [UnderlineNav](/ | |
| </> | ||
| ``` | ||
|
|
||
| ### With aria-label | ||
|
|
||
| ```jsx live drafts | ||
| <NavList aria-label="Security"> | ||
| <NavList.Item href="/" aria-current="page"> | ||
| Overview | ||
|
|
@@ -219,24 +116,9 @@ To render a horizontal list of navigation links, consider using [UnderlineNav](/ | |
| </NavList> | ||
| ``` | ||
|
|
||
| ### With groups | ||
|
|
||
| ```jsx live drafts | ||
| <NavList> | ||
| <NavList.Group title="Overview"> | ||
| <NavList.Item href="/getting-started" aria-current="page"> | ||
|
|
@@ -251,34 +133,10 @@ To render a horizontal list of navigation links, consider using [UnderlineNav](/ | |
| </NavList> | ||
| ``` | ||
|
|
||
| ### With sub-items | ||
|
|
||
| <Note variant="danger">Not implemented yet</Note> | ||
|
|
||
| ```jsx | ||
| <NavList> | ||
| <NavList.Item href="/branches">Branches</NavList.Item> | ||
|
|
@@ -325,9 +183,11 @@ If a `NavList.Item` contains a `NavList.SubNav`, the `NavList.Item` will render | |
|
|
||
| ### With a divider | ||
|
|
||
| ```jsx live drafts | ||
| <NavList> | ||
| <NavList.Item href="/" aria-current="page"> | ||
| Dashboard | ||
| </NavList.Item> | ||
| <NavList.Item href="/pulls">Pull requests</NavList.Item> | ||
| <NavList.Item href="/issues">Issues</NavList.Item> | ||
| <NavList.Divider /> | ||
|
There was a problem hiding this comment. This is interesting 🤔 Would we also want to support There was a problem hiding this comment. I don't think dividers in between individual items is part of the NavList design cc @vdepizzol |
||
|
|
@@ -336,26 +196,10 @@ If a `NavList.Item` contains a `NavList.SubNav`, the `NavList.Item` will render | |
| </NavList> | ||
| ``` | ||
|
|
||
| ### With React Router | ||
|
|
||
| <Note variant="danger">Not implemented yet</Note> | ||
|
|
||
| ```jsx | ||
| import {Link, useMatch, useResolvedPath} from 'react-router-dom' | ||
| import {NavList} from '@primer/react' | ||
|
|
@@ -383,6 +227,8 @@ function App() { | |
|
|
||
| ### With Next.js | ||
|
|
||
| <Note variant="danger">Not implemented yet</Note> | ||
|
|
||
| ```jsx | ||
| import {useRouter} from 'next/router' | ||
| import Link from 'next/link' | ||
|
|
@@ -506,10 +352,10 @@ function App() { | |
| <ComponentChecklist | ||
| items={{ | ||
| propsDocumented: true, | ||
| noUnnecessaryDeps: true, | ||
| adaptsToThemes: true, | ||
| adaptsToScreenSizes: true, | ||
| fullTestCoverage: true, | ||
| usedInProduction: false, | ||
| usageExamplesDocumented: true, | ||
| hasStorybookStories: false, | ||
|
|
||
This file contains 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
Oops, something went wrong.
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.
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.
Good example!