rsnext/examples/active-class-name/components/ActiveLink.tsx
Miroslav Petrov 47d2dfdb54
Update examples/active-class-name (#62506)
### Description
The current implementation of the activeClassName example doesn't
support the `UrlObject` type for the "href" Link prop.
For example
```
<ActiveLink
  activeClassName="active"
  className="nav-link"
  href={{
    pathname: "/[slug]",
    query: {
      slug: "dynamic-route",
    },
  }}
>
  Dynamic Route
</ActiveLink>
```
won't work.

### Suggestion
We can use the `resolveHref` function to handle all cases.

Co-authored-by: Sam Ko <sam@vercel.com>
2024-02-26 16:40:16 +00:00

78 lines
1.9 KiB
TypeScript

import { useRouter } from "next/router";
import Link, { LinkProps } from "next/link";
import React, { PropsWithChildren, useEffect, useState } from "react";
import { NextRouter } from "next/src/shared/lib/router/router";
import { resolveHref } from "next/dist/client/resolve-href";
const getLinkUrl = (params: {
router: NextRouter;
href: LinkProps["href"];
as: LinkProps["as"];
}): string => {
// Dynamic route will be matched via props.as
// Static route will be matched via props.href
if (params.as) return resolveHref(params.router, params.as);
const [resolvedHref, resolvedAs] = resolveHref(
params.router,
params.href,
true,
);
return resolvedAs || resolvedHref;
};
type ActiveLinkProps = LinkProps & {
className?: string;
activeClassName: string;
};
const ActiveLink = ({
children,
activeClassName,
className,
...props
}: PropsWithChildren<ActiveLinkProps>) => {
const router = useRouter();
const [computedClassName, setComputedClassName] = useState(className);
useEffect(() => {
// Check if the router fields are updated client-side
if (router.isReady) {
const linkUrl = getLinkUrl({
router,
href: props.href,
as: props.as,
});
const linkPathname = new URL(linkUrl, location.href).pathname;
// Using URL().pathname to get rid of query and hash
const activePathname = new URL(router.asPath, location.href).pathname;
const newClassName =
linkPathname === activePathname
? `${className} ${activeClassName}`.trim()
: className;
if (newClassName !== computedClassName) {
setComputedClassName(newClassName);
}
}
}, [
router,
props.as,
props.href,
activeClassName,
className,
computedClassName,
]);
return (
<Link className={computedClassName} {...props}>
{children}
</Link>
);
};
export default ActiveLink;