NavList.Item: Go one level deeper for NextJSLikeLink

[siddharthkp]

Demo: https://1hp8zb.csb.app/2-1
Demo code: https://codesandbox.io/s/nice-firefly-1hp8zb?file=/src/App.tsx&initialpath=/2-1

summary:

It's not necessary that the direct child of SubNav is NavList.Item, there are 3 possibilities:

1. NavList.Item as={ReactRouterLikeLink}: this one's pretty easy to check as aria-current is still on NavList.Item so checking direct children still works. source

   <NavList.Item
     as={ReactRouterLikeLink}
     to="/3-1"
     aria-current={window.location.pathname === '/3-1'}
   >
     Sub link 3-1
   </NavList.Item>

2. NextJSLikeLink: This one requires more work because the NavList.Item is nested one layer deep, but it's still predictable. source

   <NextJSLikeLink href="/2">
     <NavList.Item aria-current={window.location.pathname === '/2'}>Link 2</NavList.Item>
   </NextJSLikeLink>

3. CustomNavLink: For this one, we cannot rely on children because the aria-current is hidden away from SubNav in a different component.

   While not ideal, we could provide some guidance on how to "extend" NavList.Item by asking folks to make sure the aria-current is present at the site of usage like the second link here:

   <NavList.SubNav>
    <CustomNavLink href="/4-1">
      Sub link 4-1, automatic doesn't work
    </CustomNavLink>
    <CustomNavLink href="/4-2" aria-current={pathname === '/4-1'}>
      {/*                      ↑ ask user to pass it on a direct child        */}
      Sub link 4-2, needs explicit prop to work
    </CustomNavLink>
   </NavList.SubNav>

   It would be even better if we can detect this in dev environments and throw a warning linking to this guidance. source

[changeset-bot]

⚠️ No Changeset found

Latest commit: d05d4d0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

size-limit report 📦

Path	Size
dist/browser.esm.js	65.92 KB (0%)
dist/browser.umd.js	66.2 KB (0%)