diff --git a/docs/components/authentication/sign-in.mdx b/docs/components/authentication/sign-in.mdx index 52949991cf..25737aa7c1 100644 --- a/docs/components/authentication/sign-in.mdx +++ b/docs/components/authentication/sign-in.mdx @@ -23,7 +23,7 @@ All props are optional. --- - `routing` - - `'hash' | 'path' | 'virtual'` + - `'hash' | 'path'` The [routing](/docs/how-clerk-works/routing) strategy for your pages.
Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React. diff --git a/docs/components/authentication/sign-up.mdx b/docs/components/authentication/sign-up.mdx index 0e005ae7d0..f26fcd8532 100644 --- a/docs/components/authentication/sign-up.mdx +++ b/docs/components/authentication/sign-up.mdx @@ -23,7 +23,7 @@ All props are optional. --- - `routing` - - `'hash' | 'path' | 'virtual'` + - `'hash' | 'path'` The [routing](/docs/how-clerk-works/routing) strategy for your pages.
Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React. diff --git a/docs/components/organization/create-organization.mdx b/docs/components/organization/create-organization.mdx index fdc5b88e3b..6519a76d22 100644 --- a/docs/components/organization/create-organization.mdx +++ b/docs/components/organization/create-organization.mdx @@ -27,7 +27,7 @@ All props are optional. --- - `routing` - - `'hash' | 'path' | 'virtual'` + - `'hash' | 'path'` The [routing](/docs/how-clerk-works/routing) strategy for your pages.
Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React. diff --git a/docs/components/organization/organization-profile.mdx b/docs/components/organization/organization-profile.mdx index ceacc9af9b..9574a642f7 100644 --- a/docs/components/organization/organization-profile.mdx +++ b/docs/components/organization/organization-profile.mdx @@ -31,7 +31,7 @@ All props are optional. --- - `routing` - - `'hash' | 'path' | 'virtual'` + - `'hash' | 'path'` The [routing](/docs/how-clerk-works/routing) strategy for your pages.
Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React. diff --git a/docs/components/user/user-profile.mdx b/docs/components/user/user-profile.mdx index a1572a99e3..8f13202406 100644 --- a/docs/components/user/user-profile.mdx +++ b/docs/components/user/user-profile.mdx @@ -20,7 +20,7 @@ All props are optional. --- - `routing` - - `'hash' | 'path' | 'virtual'` + - `'hash' | 'path'` The [routing](/docs/how-clerk-works/routing) strategy for your pages.
Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React. diff --git a/docs/how-clerk-works/routing.mdx b/docs/how-clerk-works/routing.mdx index 9c1fc7b2bf..c72e60a0d7 100644 --- a/docs/how-clerk-works/routing.mdx +++ b/docs/how-clerk-works/routing.mdx @@ -17,11 +17,10 @@ The following Clerk components accept a `routing` prop in order to define the ro - [``](/docs/components/organization/create-organization) - [``](/docs/components/organization/organization-profile) -There are three routing strategies that can be passed: +There following routing strategies can be passed: - [`path`](#path-routing) - [`hash`](#hash-routing) -- [`virtual`](#virtual-routing) Clerk will attempt to select the routing strategy that best integrates with your framework of choice. If for some reason the default routing strategy doesn't work for you, use the information below to pick a strategy that will work for your setup. @@ -45,9 +44,3 @@ For the following SDKs, `path` routing is set _by default_ on all Clerk componen For example, say you have a Clerk + React application with the `` component on a dedicated `/sign-up` page. A user visit this page and uses their email address to fill out the `` form. Once they submit the form, they are redirected from `/sign-up` to `/sign-up#verify-email-address`. In Clerk applications that use any SDK other than Next.js or Remix, `hash` routing is set _by default_ on all Clerk components. - -### `virtual` routing - -`virtual` routing uses a memory router to determine the route. A memory router manages its own history stack in memory instead of using any part of the URL. This is useful for modals and other UI components that don't need to change the URL. **This option is considered experimental.** - -For example, say you have a Clerk + Next.js application with the `` component. When a user selects the `` and selects **Manage account**, a modal appears with the user's account information. The modal does not change the URL, but it does change the UI. You can navigate between both the tabs of the modal, **Profile** and **Security**, and initiate flows within the modal, such as adding a new email address, all without changing the URL. diff --git a/docs/upgrade-guides/core-2/chrome-extension.mdx b/docs/upgrade-guides/core-2/chrome-extension.mdx index eb88005f1e..4dca7c450a 100644 --- a/docs/upgrade-guides/core-2/chrome-extension.mdx +++ b/docs/upgrade-guides/core-2/chrome-extension.mdx @@ -172,7 +172,7 @@ If you would like to have your JWT return all of the user's organizations, you c ### Path routing is now the default -On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). +On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). In Core 2, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are: diff --git a/docs/upgrade-guides/core-2/expo.mdx b/docs/upgrade-guides/core-2/expo.mdx index b6b8320d71..1a0b6f4d7c 100644 --- a/docs/upgrade-guides/core-2/expo.mdx +++ b/docs/upgrade-guides/core-2/expo.mdx @@ -152,7 +152,7 @@ If you would like to have your JWT return all of the user's organizations, you c ### Path routing is now the default -On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). +On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). In Core 2, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are: diff --git a/docs/upgrade-guides/core-2/javascript.mdx b/docs/upgrade-guides/core-2/javascript.mdx index 8adb552824..5becd27bb6 100644 --- a/docs/upgrade-guides/core-2/javascript.mdx +++ b/docs/upgrade-guides/core-2/javascript.mdx @@ -161,7 +161,7 @@ If you would like to have your JWT return all of the user's organizations, you c ### Path routing is now the default -On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). +On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). In Core 2, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are: diff --git a/docs/upgrade-guides/core-2/nextjs.mdx b/docs/upgrade-guides/core-2/nextjs.mdx index 362686eb17..936279a981 100644 --- a/docs/upgrade-guides/core-2/nextjs.mdx +++ b/docs/upgrade-guides/core-2/nextjs.mdx @@ -548,13 +548,12 @@ If you would like to have your JWT return all of the user's organizations, you c ### Path routing is now the default -On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` describes the routing strategy that should be used and can be set to `'hash' | 'path' | 'virtual'`. `path` defines where the component is mounted when `routing='path'` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). +On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` describes the routing strategy that should be used and can be set to `'hash' | 'path'`. `path` defines where the component is mounted when `routing='path'` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). -In Core 2, the **default** `routing` strategy has become `'path'` for the Next.js SDK. Of course, you can still use `routing='hash'` or `routing='virtual'`. +In Core 2, the **default** `routing` strategy has become `'path'` for the Next.js SDK. Of course, you can still use `routing='hash'`. ```jsx {{ prettier: false }} - ``` ### Image URL Name Consolidation diff --git a/docs/upgrade-guides/core-2/react.mdx b/docs/upgrade-guides/core-2/react.mdx index 416f0180b7..7e07ddc715 100644 --- a/docs/upgrade-guides/core-2/react.mdx +++ b/docs/upgrade-guides/core-2/react.mdx @@ -189,7 +189,7 @@ If you would like to have your JWT return all of the user's organizations, you c ### Path routing is now the default -On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). +On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). In Core 2, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are: diff --git a/docs/upgrade-guides/core-2/remix.mdx b/docs/upgrade-guides/core-2/remix.mdx index bd53cf6199..215e6858a7 100644 --- a/docs/upgrade-guides/core-2/remix.mdx +++ b/docs/upgrade-guides/core-2/remix.mdx @@ -195,13 +195,12 @@ If you would like to have your JWT return all of the user's organizations, you c ### Path routing is now the default -On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` describes the routing strategy that should be used and can be set to `'hash' | 'path' | 'virtual'`. `path` defines where the component is mounted when `routing='path'` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). +On components like [``](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` describes the routing strategy that should be used and can be set to `'hash' | 'path'`. `path` defines where the component is mounted when `routing='path'` is used. [Learn more about Clerk routing](/docs/how-clerk-works/routing). -In Core 2, the **default** `routing` strategy has become `'path'` for the Remix SDK. Of course, you can still use `routing='hash'` or `routing='virtual'`. +In Core 2, the **default** `routing` strategy has become `'path'` for the Remix SDK. Of course, you can still use `routing='hash'`. ```jsx {{ prettier: false }} - ``` ### Image URL Name Consolidation