Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: better support for custom <PrismicLink> components using forwardRef() #132

Merged
merged 1 commit into from
Mar 9, 2022
Merged

fix: better support for custom <PrismicLink> components using forwardRef() #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 15 additions & 31 deletions src/PrismicLink.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,6 @@ import { isInternalURL } from "./lib/isInternalURL";

import { usePrismicContext } from "./usePrismicContext";

// This module-specific `forwardRef()` type override adds support for
// components using generics in its props type.
//
// Other modules will not be affected.
declare module "react" {
function forwardRef<T, P = Record<string, never>>(
render: (props: P, ref: React.Ref<T>) => JSX.Element | null,
): (props: P & React.RefAttributes<T>) => JSX.Element | null;
}

/**
* Props provided to a component when rendered with `<PrismicLink>`.
*/
Expand Down Expand Up @@ -51,8 +41,8 @@ export type PrismicLinkProps<
ExternalComponent extends React.ElementType<LinkProps> = React.ElementType<LinkProps>,
LinkResolverFunction extends prismicH.LinkResolverFunction = prismicH.LinkResolverFunction,
> = Omit<
React.ComponentProps<InternalComponent> &
React.ComponentProps<ExternalComponent>,
React.ComponentPropsWithoutRef<InternalComponent> &
React.ComponentPropsWithoutRef<ExternalComponent>,
keyof LinkProps
> & {
/**
Expand Down Expand Up @@ -146,30 +136,14 @@ const _PrismicLink = <
InternalComponent extends React.ElementType<LinkProps> = typeof defaultInternalComponent,
ExternalComponent extends React.ElementType<LinkProps> = typeof defaultExternalComponent,
LinkResolverFunction extends prismicH.LinkResolverFunction = prismicH.LinkResolverFunction,
Ref extends
| (InternalComponent extends keyof HTMLElementTagNameMap
? HTMLElementTagNameMap[InternalComponent]
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
any)
| (ExternalComponent extends keyof HTMLElementTagNameMap
? HTMLElementTagNameMap[ExternalComponent]
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
any) =
| (InternalComponent extends keyof HTMLElementTagNameMap
? HTMLElementTagNameMap[InternalComponent]
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
any)
| (ExternalComponent extends keyof HTMLElementTagNameMap
? HTMLElementTagNameMap[ExternalComponent]
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
any),
>(
props: PrismicLinkProps<
InternalComponent,
ExternalComponent,
LinkResolverFunction
>,
ref: React.ForwardedRef<Ref>,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
ref: React.Ref<any>,
): JSX.Element | null => {
const context = usePrismicContext();

Expand Down Expand Up @@ -239,4 +213,14 @@ const _PrismicLink = <
) : null;
};

export const PrismicLink = React.forwardRef(_PrismicLink);
export const PrismicLink = React.forwardRef(_PrismicLink) as <
InternalComponent extends React.ElementType<LinkProps>,
ExternalComponent extends React.ElementType<LinkProps>,
LinkResolverFunction extends prismicH.LinkResolverFunction,
>(
props: PrismicLinkProps<
InternalComponent,
ExternalComponent,
LinkResolverFunction
> & { ref?: React.Ref<Element> },
) => JSX.Element | null;