Skip to main content
Docs

<TaskResetPassword /> component

The <TaskResetPassword /> component renders a UI for resolving the reset-password session task.

The <TaskResetPassword /> component renders a UI for resolving the reset-password . You can further customize your <TaskResetPassword /> component by passing additional properties at the time of rendering.

Important

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

When to use <TaskResetPassword />

Clerk's sign-in flows, such as the Sign-in Account Portal page, <SignInButton />, and <SignIn /> component, automatically handle the reset-password session task flow for you, including rendering the <TaskResetPassword /> component when needed.

If you want to customize the route where the <TaskResetPassword /> component is rendered or customize its appearance, you can host it yourself within your application.

Example

The following example demonstrates how to host the <TaskResetPassword /> component on a custom page. You first need to set the taskUrls option on your Clerk integration so that users are redirected to the page where you host the <TaskResetPassword /> component when they have a pending reset-password session task.

index.tsx
import React from 'react'
import ReactDOM from 'react-dom/client'
import App from './App.tsx'
import { ClerkProvider } from '@clerk/clerk-react'

// Import your Publishable Key
const PUBLISHABLE_KEY = import.meta.env.VITE_CLERK_PUBLISHABLE_KEY

if (!PUBLISHABLE_KEY) {
  throw new Error('Add your Clerk Publishable Key to the .env file')
}

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <ClerkProvider
      publishableKey={PUBLISHABLE_KEY}
      taskUrls={{ 'reset-password': '/onboarding/reset-password' }}
    >
      <App />
    </ClerkProvider>
  </React.StrictMode>,
)
src/onboarding/reset-password.tsx
import { TaskResetPassword } from '@clerk/clerk-react'

const ResetPasswordPage = () => <TaskResetPassword redirectUrlComplete="/dashboard" />

export default ResetPasswordPage
  • Name
    redirectUrlComplete
    Type
    string
    Description

    The full URL or path to navigate to after successfully completing the task.

  • 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?

Last updated on

GitHubEdit on GitHub