跳到内容
从 NextAuth.js v4 迁移?阅读 我们的迁移指南.
指南页面自定义错误

自定义错误页面

Auth.js 可以配置为在用户身份验证流程(登录、退出等)中出现错误时显示自定义错误页面。

为了覆盖 Auth.js 的 /api/auth/error 页面,我们必须在 AuthConfig 中定义我们的自定义页面

./auth.ts
const authConfig: NextAuthConfig = {
...
  pages: {
    error: "/error",
  }
...
};

使用 示例应用程序,让我们通过创建 app/error/page.tsx 来构建一个简单的自定义错误页面

app/error/page.tsx
export default function AuthErrorPage() {
  return <>Oops</>
}

Auth.js 将以下错误作为错误查询参数转发到我们自定义错误页面的 URL 中

查询参数示例 URL描述
配置/auth/error?error=Configuration服务器配置存在问题。检查您的选项是否正确。
AccessDenied/auth/error?error=AccessDenied通常发生在您通过 signIn 回调或 redirect 回调限制访问时。
Verification/auth/error?error=Verification与电子邮件提供商相关。令牌已过期或已被使用。
Default/auth/error?error=Default全部捕获,如果以上都没有匹配,将应用。

所以现在我们可以用它更新我们的自定义错误页面

app/error/page.tsx
"use client"
 
import { useSearchParams } from "next/navigation"
 
enum Error {
  Configuration = "Configuration",
}
 
const errorMap = {
  [Error.Configuration]: (
    <p>
      There was a problem when trying to authenticate. Please contact us if this
      error persists. Unique error code:{" "}
      <code className="rounded-sm bg-slate-100 p-1 text-xs">Configuration</code>
    </p>
  ),
}
 
export default function AuthErrorPage() {
  const search = useSearchParams()
  const error = search.get("error") as Error
 
  return (
    <div className="flex h-screen w-full flex-col items-center justify-center">
      <a
        href="#"
        className="block max-w-sm rounded-lg border border-gray-200 bg-white p-6 text-center shadow hover:bg-gray-100 dark:border-gray-700 dark:bg-gray-800 dark:hover:bg-gray-700"
      >
        <h5 className="mb-2 flex flex-row items-center justify-center gap-2 text-xl font-bold tracking-tight text-gray-900 dark:text-white">
          Something went wrong
        </h5>
        <div className="font-normal text-gray-700 dark:text-gray-400">
          {errorMap[error] || "Please contact us if this error persists."}
        </div>
      </a>
    </div>
  )
}

现在,当出现错误时,Auth.js 将将用户重定向到我们的自定义错误页面

Custom Error Page
Auth.js © Balázs Orbán 和团队 -2024