feat: export type NavLinkRenderProps

[zeromask1337]

Documentation tells us we can use callbacks to utilize various NavLink states

import { NavLink } from "react-router-dom";

<NavLink
  to="/messages"
  className={({ isActive, isPending }) =>
    isPending ? "pending" : isActive ? "active" : ""
  }
>
  Messages
</NavLink>;

But then restricts us by not letting use type annotation for it

import { NavLink } from 'react-router-dom';
import { useCallback } from 'react';

export const Header = () => {
  const navLinkClassName = useCallback(
    ({ isActive, isPending }: NavLinkRenderProps) => // this is impossible right now because type is not exported
      isPending ? 'text-gray-500' : isActive ? 'text-orange-800' : '',
    [],
  );
  return (
    <>
      <header className='h-10 w-full bg-amber-100'>
        <nav className='p-2'>
          <ul className='flex items-center gap-5'>
            <li>
              <NavLink to='/home' className={navLinkClassName}>
                Home
              </NavLink>
            </li>
            <li>
              <NavLink to='/search' className={navLinkClassName}>
                Search
              </NavLink>
            </li>
          </ul>
        </nav>
      </header>
    </>
  );
};

You might say that we can just map over array of links, as usual, but that again restricts us from building more complex and type safe logic

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0a7287b

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

[remix-cla-bot]

Hi @zeromask1337,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳