Skip to main content
Docs

<TaskChooseOrganization /> component

The <TaskChooseOrganization /> component renders a UI for resolving the choose-organization session task.

The <TaskChooseOrganization /> component renders a UI for resolving the choose-organization session task. The functionality of the <TaskChooseOrganization /> component is controlled by the instance settings you specify in the Clerk Dashboard, such as sign-in and sign-up options and social connections. You can further customize your <TaskChooseOrganization /> component by passing additional properties at the time of rendering.

Important

The <TaskChooseOrganization/> component cannot render when a user doesn't have current session tasks.

Example

The following example demonstrates how to host the <TaskChooseOrganization /> component on a custom page.

Note

To see the full __root.tsx setup you need for Clerk with TanStack React Start, see the TanStack React Start quickstart.

src/routes/__root.tsx
import * as React from 'react'
import { HeadContent, Scripts } from '@tanstack/react-router'
import { ClerkProvider } from '@clerk/tanstack-react-start'

function RootDocument({ children }: { children: React.ReactNode }) {
  return (
    <ClerkProvider taskUrls={{ 'choose-organization': '/onboarding/choose-organization' }}>
      <html>
        <head>
          <HeadContent />
        </head>
        <body>
          {children}
          <Scripts />
        </body>
      </html>
    </ClerkProvider>
  )
}

The <TaskChooseOrganization /> component must be used in conjunction with the <SignIn /> component. See the dedicated guide on how to self-host the <SignIn /> component.

src/routes/onboarding/choose-organization.tsx
import { TaskChooseOrganization } from '@clerk/tanstack-react-start'
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/onboarding/choose-organization')({
  component: ChooseOrganizationPage,
})

function ChooseOrganizationPage() {
  return <TaskChooseOrganization redirectUrlComplete="/dashboard" />
}

Properties

All props are optional.

  • Name
    redirectUrlComplete
    Type
    string
    Description

    The full URL or path to navigate to after successfully completing all tasks.

  • Name
    appearance
    Type
    Appearance | undefined
    Description

    Optional object to style your components. Will only affect Clerk components and not Account Portal pages.

Customization

To learn about how to customize Clerk components, see the customization documentation.

If Clerk's prebuilt components don't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API. For more information, see the custom flow guides.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on