|
|
--- |
|
|
title: Updating Data |
|
|
description: Learn how to mutate data using Server Functions. |
|
|
related: |
|
|
title: API Reference |
|
|
description: Learn more about the features mentioned in this page by reading the API Reference. |
|
|
links: |
|
|
- app/api-reference/functions/revalidatePath |
|
|
- app/api-reference/functions/revalidateTag |
|
|
- app/api-reference/functions/redirect |
|
|
--- |
|
|
|
|
|
You can update data in Next.js using React's [Server Functions](https: |
|
|
|
|
|
## What are Server Functions? |
|
|
|
|
|
A **Server Function** is an asynchronous function that runs on the server. They can be called from client through a network request, which is why they must be asynchronous. |
|
|
|
|
|
In an `action` or mutation context, they are also called **Server Actions**. |
|
|
|
|
|
By convention, a Server Action is an async function used with [`startTransition`](https: |
|
|
|
|
|
- Passed to a `<form>` using the `action` prop. |
|
|
- Passed to a `<button>` using the `formAction` prop. |
|
|
|
|
|
In Next.js, Server Actions integrate with the framework's [caching](/docs/app/guides/caching) architecture. When an action is invoked, Next.js can return both the updated UI and new data in a single server roundtrip. |
|
|
|
|
|
Behind the scenes, actions use the `POST` method, and only this HTTP method can invoke them. |
|
|
|
|
|
## Creating Server Functions |
|
|
|
|
|
A Server Function can be defined by using the [`use server`](https: |
|
|
|
|
|
```ts filename="app/lib/actions.ts" switcher |
|
|
export async function createPost(formData: FormData) { |
|
|
'use server' |
|
|
const title = formData.get('title') |
|
|
const content = formData.get('content') |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
|
|
|
export async function deletePost(formData: FormData) { |
|
|
'use server' |
|
|
const id = formData.get('id') |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
``` |
|
|
|
|
|
```js filename="app/lib/actions.js" switcher |
|
|
export async function createPost(formData) { |
|
|
'use server' |
|
|
const title = formData.get('title') |
|
|
const content = formData.get('content') |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
|
|
|
export async function deletePost(formData) { |
|
|
'use server' |
|
|
const id = formData.get('id') |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
``` |
|
|
|
|
|
### Server Components |
|
|
|
|
|
Server Functions can be inlined in Server Components by adding the `"use server"` directive to the top of the function body: |
|
|
|
|
|
```tsx filename="app/page.tsx" switcher |
|
|
export default function Page() { |
|
|
|
|
|
async function createPost(formData: FormData) { |
|
|
'use server' |
|
|
|
|
|
} |
|
|
|
|
|
return <></> |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/page.js" switcher |
|
|
export default function Page() { |
|
|
|
|
|
async function createPost(formData: FormData) { |
|
|
'use server' |
|
|
|
|
|
} |
|
|
|
|
|
return <></> |
|
|
} |
|
|
``` |
|
|
|
|
|
> **Good to know:** Server Components support progressive enhancement by default, meaning forms that call Server Actions will be submitted even if JavaScript hasn't loaded yet or is disabled. |
|
|
|
|
|
### Client Components |
|
|
|
|
|
It's not possible to define Server Functions in Client Components. However, you can invoke them in Client Components by importing them from a file that has the `"use server"` directive at the top of it: |
|
|
|
|
|
```ts filename="app/actions.ts" switcher |
|
|
'use server' |
|
|
|
|
|
export async function createPost() {} |
|
|
``` |
|
|
|
|
|
```js filename="app/actions.js" switcher |
|
|
'use server' |
|
|
|
|
|
export async function createPost() {} |
|
|
``` |
|
|
|
|
|
```tsx filename="app/ui/button.tsx" switcher |
|
|
'use client' |
|
|
|
|
|
import { createPost } from '@/app/actions' |
|
|
|
|
|
export function Button() { |
|
|
return <button formAction={createPost}>Create</button> |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/ui/button.js" switcher |
|
|
'use client' |
|
|
|
|
|
import { createPost } from '@/app/actions' |
|
|
|
|
|
export function Button() { |
|
|
return <button formAction={createPost}>Create</button> |
|
|
} |
|
|
``` |
|
|
|
|
|
> **Good to know:** In Client Components, forms invoking Server Actions will queue submissions if JavaScript isn't loaded yet, and will be prioritized for hydration. After hydration, the browser does not refresh on form submission. |
|
|
|
|
|
### Passing actions as props |
|
|
|
|
|
You can also pass an action to a Client Component as a prop: |
|
|
|
|
|
```jsx |
|
|
<ClientComponent updateItemAction={updateItem} /> |
|
|
``` |
|
|
|
|
|
```tsx filename="app/client-component.tsx" switcher |
|
|
'use client' |
|
|
|
|
|
export default function ClientComponent({ |
|
|
updateItemAction, |
|
|
}: { |
|
|
updateItemAction: (formData: FormData) => void |
|
|
}) { |
|
|
return <form action={updateItemAction}>{}</form> |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/client-component.js" switcher |
|
|
'use client' |
|
|
|
|
|
export default function ClientComponent({ updateItemAction }) { |
|
|
return <form action={updateItemAction}>{}</form> |
|
|
} |
|
|
``` |
|
|
|
|
|
## Invoking Server Functions |
|
|
|
|
|
There are two main ways you can invoke a Server Function: |
|
|
|
|
|
1. [Forms](#forms) in Server and Client Components |
|
|
2. [Event Handlers](#event-handlers) and [useEffect](#useeffect) in Client Components |
|
|
|
|
|
### Forms |
|
|
|
|
|
React extends the HTML [`<form>`](https: |
|
|
|
|
|
When invoked in a form, the function automatically receives the [`FormData`](https: |
|
|
|
|
|
```tsx filename="app/ui/form.tsx" switcher |
|
|
import { createPost } from '@/app/actions' |
|
|
|
|
|
export function Form() { |
|
|
return ( |
|
|
<form action={createPost}> |
|
|
<input type="text" name="title" /> |
|
|
<input type="text" name="content" /> |
|
|
<button type="submit">Create</button> |
|
|
</form> |
|
|
) |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/ui/form.js" switcher |
|
|
import { createPost } from '@/app/actions' |
|
|
|
|
|
export function Form() { |
|
|
return ( |
|
|
<form action={createPost}> |
|
|
<input type="text" name="title" /> |
|
|
<input type="text" name="content" /> |
|
|
<button type="submit">Create</button> |
|
|
</form> |
|
|
) |
|
|
} |
|
|
``` |
|
|
|
|
|
```ts filename="app/actions.ts" switcher |
|
|
'use server' |
|
|
|
|
|
export async function createPost(formData: FormData) { |
|
|
const title = formData.get('title') |
|
|
const content = formData.get('content') |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
``` |
|
|
|
|
|
```js filename="app/actions.js" switcher |
|
|
'use server' |
|
|
|
|
|
export async function createPost(formData) { |
|
|
const title = formData.get('title') |
|
|
const content = formData.get('content') |
|
|
|
|
|
|
|
|
|
|
|
} |
|
|
``` |
|
|
|
|
|
### Event Handlers |
|
|
|
|
|
You can invoke a Server Function in a Client Component by using event handlers such as `onClick`. |
|
|
|
|
|
```tsx filename="app/like-button.tsx" switcher |
|
|
'use client' |
|
|
|
|
|
import { incrementLike } from './actions' |
|
|
import { useState } from 'react' |
|
|
|
|
|
export default function LikeButton({ initialLikes }: { initialLikes: number }) { |
|
|
const [likes, setLikes] = useState(initialLikes) |
|
|
|
|
|
return ( |
|
|
<> |
|
|
<p>Total Likes: {likes}</p> |
|
|
<button |
|
|
onClick={async () => { |
|
|
const updatedLikes = await incrementLike() |
|
|
setLikes(updatedLikes) |
|
|
}} |
|
|
> |
|
|
Like |
|
|
</button> |
|
|
</> |
|
|
) |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/like-button.js" switcher |
|
|
'use client' |
|
|
|
|
|
import { incrementLike } from './actions' |
|
|
import { useState } from 'react' |
|
|
|
|
|
export default function LikeButton({ initialLikes }) { |
|
|
const [likes, setLikes] = useState(initialLikes) |
|
|
|
|
|
return ( |
|
|
<> |
|
|
<p>Total Likes: {likes}</p> |
|
|
<button |
|
|
onClick={async () => { |
|
|
const updatedLikes = await incrementLike() |
|
|
setLikes(updatedLikes) |
|
|
}} |
|
|
> |
|
|
Like |
|
|
</button> |
|
|
</> |
|
|
) |
|
|
} |
|
|
``` |
|
|
|
|
|
## Examples |
|
|
|
|
|
### Showing a pending state |
|
|
|
|
|
While executing a Server Function, you can show a loading indicator with React's [`useActionState`](https: |
|
|
|
|
|
```tsx filename="app/ui/button.tsx" switcher |
|
|
'use client' |
|
|
|
|
|
import { useActionState, startTransition } from 'react' |
|
|
import { createPost } from '@/app/actions' |
|
|
import { LoadingSpinner } from '@/app/ui/loading-spinner' |
|
|
|
|
|
export function Button() { |
|
|
const [state, action, pending] = useActionState(createPost, false) |
|
|
|
|
|
return ( |
|
|
<button onClick={() => startTransition(action)}> |
|
|
{pending ? <LoadingSpinner /> : 'Create Post'} |
|
|
</button> |
|
|
) |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/ui/button.js" switcher |
|
|
'use client' |
|
|
|
|
|
import { useActionState, startTransition } from 'react' |
|
|
import { createPost } from '@/app/actions' |
|
|
import { LoadingSpinner } from '@/app/ui/loading-spinner' |
|
|
|
|
|
export function Button() { |
|
|
const [state, action, pending] = useActionState(createPost, false) |
|
|
|
|
|
return ( |
|
|
<button onClick={() => startTransition(action)}> |
|
|
{pending ? <LoadingSpinner /> : 'Create Post'} |
|
|
</button> |
|
|
) |
|
|
} |
|
|
``` |
|
|
|
|
|
### Revalidating |
|
|
|
|
|
After performing an update, you can revalidate the Next.js cache and show the updated data by calling [`revalidatePath`](/docs/app/api-reference/functions/revalidatePath) or [`revalidateTag`](/docs/app/api-reference/functions/revalidateTag) within the Server Function: |
|
|
|
|
|
```ts filename="app/lib/actions.ts" switcher |
|
|
import { revalidatePath } from 'next/cache' |
|
|
|
|
|
export async function createPost(formData: FormData) { |
|
|
'use server' |
|
|
|
|
|
|
|
|
|
|
|
revalidatePath('/posts') |
|
|
} |
|
|
``` |
|
|
|
|
|
```js filename="app/actions.js" switcher |
|
|
import { revalidatePath } from 'next/cache' |
|
|
|
|
|
export async function createPost(formData) { |
|
|
'use server' |
|
|
|
|
|
|
|
|
revalidatePath('/posts') |
|
|
} |
|
|
``` |
|
|
|
|
|
### Redirecting |
|
|
|
|
|
You may want to redirect the user to a different page after performing an update. You can do this by calling [`redirect`](/docs/app/api-reference/functions/redirect) within the Server Function: |
|
|
|
|
|
```ts filename="app/lib/actions.ts" switcher |
|
|
'use server' |
|
|
|
|
|
import { redirect } from 'next/navigation' |
|
|
|
|
|
export async function createPost(formData: FormData) { |
|
|
|
|
|
|
|
|
|
|
|
redirect('/posts') |
|
|
} |
|
|
``` |
|
|
|
|
|
```js filename="app/actions.js" switcher |
|
|
'use server' |
|
|
|
|
|
import { redirect } from 'next/navigation' |
|
|
|
|
|
export async function createPost(formData) { |
|
|
|
|
|
|
|
|
|
|
|
redirect('/posts') |
|
|
} |
|
|
``` |
|
|
|
|
|
### Cookies |
|
|
|
|
|
You can `get`, `set`, and `delete` cookies inside a Server Action using the [`cookies`](/docs/app/api-reference/functions/cookies) API: |
|
|
|
|
|
```ts filename="app/actions.ts" switcher |
|
|
'use server' |
|
|
|
|
|
import { cookies } from 'next/headers' |
|
|
|
|
|
export async function exampleAction() { |
|
|
const cookieStore = await cookies() |
|
|
|
|
|
|
|
|
cookieStore.get('name')?.value |
|
|
|
|
|
|
|
|
cookieStore.set('name', 'Delba') |
|
|
|
|
|
|
|
|
cookieStore.delete('name') |
|
|
} |
|
|
``` |
|
|
|
|
|
```js filename="app/actions.js" switcher |
|
|
'use server' |
|
|
|
|
|
import { cookies } from 'next/headers' |
|
|
|
|
|
export async function exampleAction() { |
|
|
|
|
|
const cookieStore = await cookies() |
|
|
|
|
|
|
|
|
cookieStore.get('name')?.value |
|
|
|
|
|
|
|
|
cookieStore.set('name', 'Delba') |
|
|
|
|
|
|
|
|
cookieStore.delete('name') |
|
|
} |
|
|
``` |
|
|
|
|
|
### useEffect |
|
|
|
|
|
You can use the React [`useEffect`](https: |
|
|
|
|
|
```tsx filename="app/view-count.tsx" switcher |
|
|
'use client' |
|
|
|
|
|
import { incrementViews } from './actions' |
|
|
import { useState, useEffect, useTransition } from 'react' |
|
|
|
|
|
export default function ViewCount({ initialViews }: { initialViews: number }) { |
|
|
const [views, setViews] = useState(initialViews) |
|
|
const [isPending, startTransition] = useTransition() |
|
|
|
|
|
useEffect(() => { |
|
|
startTransition(async () => { |
|
|
const updatedViews = await incrementViews() |
|
|
setViews(updatedViews) |
|
|
}) |
|
|
}, []) |
|
|
|
|
|
|
|
|
return <p>Total Views: {views}</p> |
|
|
} |
|
|
``` |
|
|
|
|
|
```jsx filename="app/view-count.js" switcher |
|
|
'use client' |
|
|
|
|
|
import { incrementViews } from './actions' |
|
|
import { useState, useEffect, useTransition } from 'react' |
|
|
|
|
|
export default function ViewCount({ initialViews }) { |
|
|
const [views, setViews] = useState(initialViews) |
|
|
const [isPending, startTransition] = useTransition() |
|
|
|
|
|
useEffect(() => { |
|
|
startTransition(async () => { |
|
|
const updatedViews = await incrementViews() |
|
|
setViews(updatedViews) |
|
|
}) |
|
|
}, []) |
|
|
|
|
|
|
|
|
return <p>Total Views: {views}</p> |
|
|
} |
|
|
``` |
|
|
|