Skip to content

feat: allow Link's "to" prop to accept external urls #9900

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

Merged
merged 10 commits into from
Jan 18, 2023
Merged

feat: allow Link's "to" prop to accept external urls #9900

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
80b977b
feat: allow Link's "to" prop to accept external urls
mcansh Jan 13, 2023
aae933c
chore: update external link detection to account for no protocol
mcansh Jan 13, 2023
9f3f1be
Update index.tsx
mcansh Jan 16, 2023
666939c
Update index.tsx
mcansh Jan 16, 2023
86e1c15
chore: update absolute url checking per https://github.com/remix-run/…
mcansh Jan 17, 2023
8a916a5
Create silent-oranges-pay.md
mcansh Jan 17, 2023
0dc51fb
chore: bump bundle size
mcansh Jan 17, 2023
727a824
chore: add browser check
mcansh Jan 17, 2023
e165b7c
Preserve absolute same origin and don't add listener on external links
brophdawg11 Jan 18, 2023
30e9e3e
chore: bump bundle size
mcansh Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions packages/react-router-dom/__tests__/link-href-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,45 @@ describe("<Link> href", () => {
["/about", "/about"]
);
});

test('<Link to="https://remix.run"> is treated as external link', () => {
let renderer: TestRenderer.ReactTestRenderer;
TestRenderer.act(() => {
renderer = TestRenderer.create(
<MemoryRouter initialEntries={["/inbox/messages"]}>
<Routes>
<Route path="inbox">
<Route
path="messages"
element={<Link to="https://remix.run" />}
/>
</Route>
</Routes>
</MemoryRouter>
);
});

expect(renderer.root.findByType("a").props.href).toEqual(
"https://remix.run"
);
});

test('<Link to="//remix.run"> is treated as external link', () => {
let renderer: TestRenderer.ReactTestRenderer;
TestRenderer.act(() => {
renderer = TestRenderer.create(
<MemoryRouter initialEntries={["/inbox/messages"]}>
<Routes>
<Route path="inbox">
<Route path="messages" element={<Link to="//remix.run" />} />
</Route>
</Routes>
</MemoryRouter>
);
});

expect(renderer.root.findByType("a").props.href).toEqual("//remix.run");
});
});

describe("in a dynamic route", () => {
Expand Down
8 changes: 5 additions & 3 deletions packages/react-router-dom/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,9 @@ export const Link = React.forwardRef<HTMLAnchorElement, LinkProps>(
},
ref
) {
let href = useHref(to, { relative });
let toString = typeof to === "string" ? to : createPath(to);
let isExternal = /^(?:[a-z][a-z0-9+.-]*:|\/\/)/i.test(toString);
let href = useHref(toString, { relative });
let internalOnClick = useLinkClickHandler(to, {
replace,
state,
Expand All @@ -430,8 +432,8 @@ export const Link = React.forwardRef<HTMLAnchorElement, LinkProps>(
// eslint-disable-next-line jsx-a11y/anchor-has-content
<a
{...rest}
href={href}
onClick={reloadDocument ? onClick : handleClick}
href={isExternal ? toString : href}
onClick={isExternal || reloadDocument ? onClick : handleClick}
ref={ref}
target={target}
/>
Expand Down