Server Actions
Clerk provides helpers to allow you to protect your Server Actions, fetch the current user, and interact with the Clerk API.
Below are some examples of usage both in Server Components or Client Components.
With server components
Protect your actions
actions.tsimport { auth } from '@clerk/nextjs/server'; export default function AddToCart() { async function addItem(formData: FormData) { 'use server'; const { userId } = auth(); if (!userId) { throw new Error('You must be signed in to add an item to your cart'); } console.log('add item server action', formData); } return ( <form action={addItem}> <input value={'test'} type='text' name='name' /> <button type='submit'>Add to Cart</button> </form> ); }
Accessing the current user
Current user data is important for data enrichment. You can use the currentUser()
helper to achieve this.
app/page.tsximport { currentUser } from '@clerk/nextjs/server'; export default function AddHobby() { async function addHobby(formData: FormData) { 'use server'; const user = await currentUser(); if (!user) { throw new Error('You must be signed in to use this feature'); } const serverData = { usersHobby: formData.get("hobby"), userId: user.id, profileImage: user.imageUrl }; console.log('add item server action completed with user details ', serverData); } return ( <form action={addHobby}> <input value={'soccer'} type='text' name='hobby' /> <button type='submit'>Submit your hobby</button> </form> ); }
With Client Components
When using Client Components, you need to make sure you use prop drilling to ensure that headers are available.
Protect your Server Actions
Server Action code
actions.ts'use server' import { auth } from '@clerk/nextjs/server'; export async function addItem(formData: FormData) { const { userId } = auth(); if (!userId) { throw new Error('You must be signed in to add an item to your cart'); } console.log('add item server action', formData); }
Server page
page.tsximport UI from "./UI"; import { addItem } from "./actions" export default function Hobby() { return ( <UI addItem={addItem} /> ); }
Client Component
ui.tsx"use client" export default function UI({ addItem }) { return ( <form action={addItem}> <input value={'test'} type='text' name='name' /> <button type='submit'>Add to Cart</button> </form> ) }
Accessing the current user
Server Action Code
actions.ts'use server' import { currentUser } from "@clerk/nextjs/server"; export async function addHobby(formData: FormData) { const user = await currentUser(); if (!user) { throw new Error('You must be signed in to use this feature'); } const serverData = { usersHobby: formData.get("hobby"), userId: user.id, profileImage: user.imageUrl }; console.log('add Hobby completed with user details ', serverData); }
Server Page
page.tsximport UI from "./ui"; import { addHobby } from "./actions" export default function Hobby() { return ( <UI addHobby={addHobby} /> ); }
Client Component
ui.tsx"use client" export default function UI({ addHobby }) { return ( <form action={addHobby}> <input value={'soccer'} type='text' name='hobby' /> <button type='submit'>Submit your hobby</button> </form> ) }
Last updated on February 23, 2024