How to mutate data
You can mutate data in Next.js using React's Server Functions. This page will go through how you can create and invoke Server Functions.
Creating Server Functions
A Server Function can be defined by using the use server
directive. You can place the directive at the top of an asynchronous function to mark the function as a Server Function, or at the top of a separate file to mark all exports of that file. We recommend using a separate file in most instances.
'use server'
export async function createPost(formData: FormData) {}
export async function deletePost(formData: FormData) {}
Server Components
Server Functions can be inlined in Server Components by adding the "use server"
directive to the top of the function body:
export async default function Page() {
// Server Action
async function createPost() {
'use server'
// Mutate data
// ...
return <></>
}
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:
'use server'
export async function createPost() {}
'use client'
import { createPost } from '@/app/actions'
export function Button() {
return <button formAction={createPost}>Create</button>
}
Invoking Server Functions
There are two mains ways you can invoke a Server Function:
- Forms in Server and Client Components
- Event Handlers in Client Components
Forms
React extends the HTML <form>
element to allow Server Function to be invoked with the HTML action
prop.
When invoked in a form, the function automatically receives the FormData
object. You can extract the data using the native FormData
methods:
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>
)
}
'use server'
export async function createPost(formData: FormData) {
const title = formData.get('title')
const content = formData.get('content')
// Mutate data
// Revalidate cache
}
Good to know: When passed to the
action
prop, Server Functions are also known as Server Actions.
Event Handlers
You can invoke a Server Function in a Client Component by using event handlers such as onClick
.
'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>
Showing a pending state
While executing a Server Function, you can show a loading indicator with React's useActionState
hook. This hook returns a pending
boolean:
'use client'
import { useActionState } 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={async () => action()}>
{pending ? <LoadingSpinner /> : 'Create Post'}
</button>
)
}
Revalidating the cache
After performing a mutation, you can revalidate the Next.js cache and show the updated data by calling revalidatePath
or revalidateTag
within the Server Function:
'use server'
import { revalidatePath } from 'next/cache'
export async function createPost(formData: FormData) {
// Mutate data
// ...
revalidatePath('/posts')
}
Redirecting
You may want to redirect the user to a different page after performing a mutation. You can do this by calling redirect
within the Server Function:
'use server'
import { redirect } from 'next/navigation'
export async function createPost(formData: FormData) {
// Mutate data
// ...
redirect('/posts')
}
API Reference
Was this helpful?