Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update pages configuration example to typescript #6596

Merged
merged 4 commits into from
Feb 3, 2023
Merged

docs: update pages configuration example to typescript #6596

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a969e0a
Update examples to TS
rawbinary Feb 2, 2023
04e0f51
docs: update files names to corresponding TSX
rawbinary Feb 2, 2023
cf68e81
Apply suggestions from code review
balazsorban44 Feb 3, 2023
5e4c0d7
Merge branch 'v4' into patch-1
balazsorban44 Feb 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions docs/docs/configuration/pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,13 @@ In addition, you can define a `theme.brandColor` to define a custom accent color

In order to get the available authentication providers and the URLs to use for them, you can make a request to the API endpoint `/api/auth/providers`:

```jsx title="pages/auth/signin.js"
```tsx title="pages/auth/signin.tsx"
import type { GetServerSidePropsContext, InferGetServerSidePropsType } from "next";
import { getProviders, signIn } from "next-auth/react"
import { getServerSession } from "next-auth/next"
import { authOptions } from "../api/auth/[...nextauth]";

export default function SignIn({ providers }) {
export default function SignIn({ providers }: InferGetServerSidePropsType<typeof getServerSideProps>) {
return (
<>
{Object.values(providers).map((provider) => (
Expand All @@ -96,7 +97,7 @@ export default function SignIn({ providers }) {
)
}

export async function getServerSideProps(context) {
export async function getServerSideProps(context: GetServerSidePropsContext) {
const session = await getServerSession(context.req, context.res, authOptions);

// If the user is already logged in, redirect.
Expand All @@ -109,7 +110,7 @@ export async function getServerSideProps(context) {
const providers = await getProviders(context);

return {
props: { providers },
props: { providers: Object.values(providers) ?? [] },
}
}
```
Expand All @@ -120,10 +121,11 @@ There is another, more fully styled example signin page available [here](https:/

If you create a custom sign in form for email sign in, you will need to submit both fields for the **email** address and **csrfToken** from **/api/auth/csrf** in a POST request to **/api/auth/signin/email**.

```jsx title="pages/auth/email-signin.js"
```tsx title="pages/auth/email-signin.tsx"
import type { GetServerSidePropsContext, InferGetServerSidePropsType } from "next";
import { getCsrfToken } from "next-auth/react"

export default function SignIn({ csrfToken }) {
export default function SignIn({ csrfToken }: InferGetServerSidePropsType<typeof getServerSideProps>) {
return (
<form method="post" action="/api/auth/signin/email">
<input name="csrfToken" type="hidden" defaultValue={csrfToken} />
Expand All @@ -136,7 +138,7 @@ export default function SignIn({ csrfToken }) {
)
}

export async function getServerSideProps(context) {
export async function getServerSideProps(context: GetServerSidePropsContext) {
const csrfToken = await getCsrfToken(context)
return {
props: { csrfToken },
Expand All @@ -146,18 +148,19 @@ export async function getServerSideProps(context) {

You can also use the `signIn()` function which will handle obtaining the CSRF token for you:

```js
```ts
signIn("email", { email: "jsmith@example.com" })
```

### Credentials Sign in

If you create a sign in form for credentials based authentication, you will need to pass a **csrfToken** from **/api/auth/csrf** in a POST request to **/api/auth/callback/credentials**.

```jsx title="pages/auth/credentials-signin.js"
```tsx title="pages/auth/credentials-signin.tsx"
import type { GetServerSidePropsContext, InferGetServerSidePropsType } from "next";
import { getCsrfToken } from "next-auth/react"

export default function SignIn({ csrfToken }) {
export default function SignIn({ csrfToken }: InferGetServerSidePropsType<typeof getServerSideProps>) {
return (
<form method="post" action="/api/auth/callback/credentials">
<input name="csrfToken" type="hidden" defaultValue={csrfToken} />
Expand All @@ -174,7 +177,7 @@ export default function SignIn({ csrfToken }) {
)
}

export async function getServerSideProps(context) {
export async function getServerSideProps(context: GetServerSidePropsContext) {
return {
props: {
csrfToken: await getCsrfToken(context),
Expand All @@ -185,7 +188,7 @@ export async function getServerSideProps(context) {

You can also use the `signIn()` function which will handle obtaining the CSRF token for you:

```js
```ts
signIn("credentials", { username: "jsmith", password: "1234" })
```

Expand Down