Skip to content

chore(clerk-js): Add virtual routing deprecation warning #5072

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 2 commits into from
Feb 5, 2025
Merged

chore(clerk-js): Add virtual routing deprecation warning #5072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10149b0
chore(clerk-js): Add virtual routing deprecation warning
alexcarpenter Feb 3, 2025
9e76956
add changeset
alexcarpenter Feb 3, 2025
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
5 changes: 5 additions & 0 deletions .changeset/friendly-ears-bow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Add virtual routing deprecation warning.
4 changes: 4 additions & 0 deletions packages/clerk-js/src/ui/lazyModules/providers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared/deprecated';
import type { Appearance } from '@clerk/types';
import React, { lazy, Suspense } from 'react';

Expand Down Expand Up @@ -56,6 +57,9 @@ type LazyComponentRendererProps = React.PropsWithChildren<
type PortalProps = Parameters<typeof Portal>[0];

export const LazyComponentRenderer = (props: LazyComponentRendererProps) => {
if (props.componentProps.routing === 'virtual') {
deprecated('routing="virtual"', 'Use routing="hash" instead.');
}
Comment on lines +60 to +62
Copy link
Member

@panteliselef panteliselef Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Asking for confirmation here, since this is only logged in LazyComponentRenderer, it means that SignInModal will not display the deprecation, but if someone does <SignIn routing="virtual" /> then it will.

Copy link
Member Author

@alexcarpenter alexcarpenter Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my testing, that is correct.

return (
<AppearanceProvider
globalAppearance={props.globalAppearance}
Expand Down