Skip to content

Commit

Permalink
remove virtual routing from how clerk works
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech committed Jan 29, 2025
1 parent 4018965 commit f221d0f
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions docs/how-clerk-works/routing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ The following Clerk components accept a `routing` prop in order to define the ro
- [`<CreateOrganization />`](/docs/components/organization/create-organization)
- [`<OrganizationProfile />`](/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.

Expand All @@ -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 `<SignUp />` component on a dedicated `/sign-up` page. A user visit this page and uses their email address to fill out the `<SignUp />` 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 `<UserButton />` component. When a user selects the `<UserButton />` 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.

0 comments on commit f221d0f

Please sign in to comment.