useActionState
useActionState は、アクション (Action) を使って副作用を伴う state 更新を行うための React フックです。
const [state, dispatchAction, isPending] = useActionState(reducerAction, initialState, permalink?);リファレンス
useActionState(reducerAction, initialState, permalink?)
コンポーネントのトップレベルで useActionState を呼び出し、アクションの結果に対応する state を作成します。
import { useActionState } from 'react';
function reducerAction(previousState, actionPayload) {
// ...
}
function MyCart({initialState}) {
const [state, dispatchAction, isPending] = useActionState(reducerAction, initialState);
// ...
}引数
reducerAction: アクションがトリガされたときに呼び出される関数。呼び出されると、1 番目の引数として前回の state(初回は渡したinitialState、以降は前回の返り値)を受け取り、その後にdispatchActionに渡されたactionPayloadを受け取ります。initialState: state の初期値として使いたい値。dispatchActionが初めて呼び出された後、React はこの引数を無視します。- 省略可能
permalink: このフォームが変更する一意なページ URL を含む文字列。- React Server Components を使うページで、プログレッシブエンハンスメントと組み合わせる場合に使用します。
reducerActionがサーバ関数であり、かつ JavaScript バンドルの読み込み完了前にフォームが送信された場合、ブラウザは現在のページ URL ではなく指定された permalink URL に移動します。
返り値
useActionState は厳密に 3 つの値を持つ配列を返します。
- 現在の state。初回レンダー中は、渡した
initialStateと一致します。dispatchActionが呼び出された後は、reducerActionが返した値と一致します。 - アクション内で呼び出す
dispatchAction関数。 - このフックでディスパッチされたアクションのうち、保留中のものがあるかどうかを知らせる
isPendingフラグ。
注意点
useActionStateはフックなので、呼び出せるのはコンポーネントのトップレベルまたは独自フックの内部だけです。ループや条件分岐の中では呼び出せません。その必要がある場合は、新しいコンポーネントを切り出して state をそこへ移動してください。- React は
dispatchActionの複数回の呼び出しをキューに入れ、順番に実行します。reducerActionの各呼び出しは、前回の呼び出し結果を受け取ります。 dispatchAction関数は安定した同一性を持つため、エフェクトの依存配列から省略されることが多いですが、含めてもエフェクトが発火することはありません。リンタが依存値の省略をエラーにしない場合、省略しても安全です。エフェクトの依存値を削除する方法について詳しく学ぶ。permalinkオプションを使う場合は、移動先ページでも同じフォームコンポーネント(同じreducerActionとpermalinkを含む)がレンダーされるようにしてください。これにより React は state をどう受け渡すかを認識できます。ページがインタラクティブになった後は、この引数は効果を持ちません。- サーバ関数 (Server Function) を使う場合、
initialStateはシリアライズ可能(プレーンオブジェクト、配列、文字列、数値などの値)である必要があります。 dispatchActionがエラーをスローした場合、React はキューに入っているすべてのアクションをキャンセルし、最も近いエラーバウンダリを表示します。- 進行中のアクションが複数ある場合、React はそれらをまとめてバッチ処理します。これは将来のリリースで取り除かれる可能性のある制限です。
reducerAction 関数
useActionState に渡す reducerAction 関数は、前回の state を受け取り、新しい state を返すものです。
useReducer のリデューサとは異なり、reducerAction は非同期にでき、副作用を実行可能です。
async function reducerAction(previousState, actionPayload) {
const newState = await post(actionPayload);
return newState;
}dispatchAction を呼び出すたびに、React は actionPayload を引数にして reducerAction を呼び出します。リデューサはデータの投稿などの副作用を実行し、新しい state を返します。dispatchAction が複数回呼び出された場合、React はそれらをキューに入れて順番に実行するため、前回の呼び出し結果が現在の呼び出しの previousState として渡されます。
引数
-
previousState: 直近の state。初回はinitialStateと等しくなります。dispatchActionの最初の呼び出し後は、直近に返された state と等しくなります。 -
省略可能
actionPayload:dispatchActionに渡される引数。任意の型の値にできます。通常はuseReducerの慣例と同様、アクションを識別するtypeプロパティと、必要に応じて追加情報を持つその他のプロパティを含むオブジェクトにします。
返り値
reducerAction は新しい state を返し、その state で再レンダーするためのトランジションをトリガします。
注意点
reducerActionは同期関数にも非同期関数にもできます。通知の表示のような同期アクションや、サーバへの更新投稿のような非同期アクションを実行できます。reducerActionは副作用を許容するように設計されているため、<StrictMode>でも 2 回呼び出されません。reducerActionの返り値の型はinitialStateの型と一致している必要があります。TypeScript の推論で型が不一致となる場合は、state の型を明示的にアノテーションする必要があるかもしれません。reducerActionの中でawait後に state をセットする場合、現在はその state 更新を追加のstartTransitionでラップする必要があります。詳しくは startTransition のドキュメントを参照してください。- サーバ関数を使う場合、
actionPayloadはシリアライズ可能(プレーンオブジェクト、配列、文字列、数値などの値)である必要があります。
さらに深く知る
useActionState に渡す関数は、以下の理由からリデューサアクションと呼ばれます:
useReducerと同じように、前回の state から新しい state へと畳み込み (reduce) を行います。- トランジション内で呼び出され、副作用を実行できるため、アクションです。
概念的には、useActionState は useReducer に似ていますが、リデューサ内で副作用を実行できます。
使用法
アクションに state を追加する
コンポーネントのトップレベルで useActionState を呼び出し、アクションの結果に対応する state を作成します。
import { useActionState } from 'react';
async function addToCartAction(prevCount) {
// ...
}
function Counter() {
const [count, dispatchAction, isPending] = useActionState(addToCartAction, 0);
// ...
}useActionState は厳密に 3 つの項目を持つ配列を返します。
- 現在の state。初期状態では、指定した初期 state に設定されます。
reducerActionをトリガするためのアクションディスパッチャ。- アクションが進行中かどうかを知らせる保留中状態。
addToCartAction を呼び出すには、アクションディスパッチャを呼び出します。React は、直近の count を引数として用いる addToCartAction の呼び出しをキューに入れます。
import { useActionState, startTransition } from 'react'; import { addToCart } from './api'; import Total from './Total'; export default function Checkout() { const [count, dispatchAction, isPending] = useActionState(async (prevCount) => { return await addToCart(prevCount) }, 0); function handleClick() { startTransition(() => { dispatchAction(); }); } return ( <div className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <span>Qty: {count}</span> </div> <div className="row"> <button onClick={handleClick}>Add Ticket{isPending ? ' 🌀' : ' '}</button> </div> <hr /> <Total quantity={count} /> </div> ); }
“Add Ticket” をクリックするたびに、React は addToCartAction の呼び出しをキューに入れます。React はすべてのチケットが追加されるまで保留中状態を表示し、その後、最終的な state で再レンダーします。
さらに深く知る
“Add Ticket” を複数回クリックしてみてください。クリックするたびに、新しい addToCartAction がキューに入ります。人工的な 1 秒の遅延があるため、4 回クリックすると完了まで約 4 秒かかります。
これは useActionState の設計上意図されたものです。
次の addToCartAction の呼び出しに prevCount を渡すためには、前回の addToCartAction の結果を待つ必要があります。つまり React は、次のアクションを呼び出す前に、前回のアクションが完了するのを待つ必要があります。
通常は useOptimistic と併用することでこれに対処できますが、より複雑なケースでは、キューに入ったアクションをキャンセルすることや、useActionState を使わないことを検討してもよいでしょう。
複数のアクションタイプを使用する
複数のタイプを処理するには、dispatchAction に引数を渡します。
慣例として、switch 文として書くことが一般的です。switch の各 case で、次の state を計算して返します。引数は任意の形にできますが、アクションを識別する type プロパティを持つオブジェクトを渡すのが一般的です。
import { useActionState, startTransition } from 'react'; import { addToCart, removeFromCart } from './api'; import Total from './Total'; export default function Checkout() { const [count, dispatchAction, isPending] = useActionState(updateCartAction, 0); function handleAdd() { startTransition(() => { dispatchAction({ type: 'ADD' }); }); } function handleRemove() { startTransition(() => { dispatchAction({ type: 'REMOVE' }); }); } return ( <div className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <span className="stepper"> <span className="qty">{isPending ? '🌀' : count}</span> <span className="buttons"> <button onClick={handleAdd}>▲</button> <button onClick={handleRemove}>▼</button> </span> </span> </div> <hr /> <Total quantity={count} isPending={isPending}/> </div> ); } async function updateCartAction(prevCount, actionPayload) { switch (actionPayload.type) { case 'ADD': { return await addToCart(prevCount); } case 'REMOVE': { return await removeFromCart(prevCount); } } return prevCount; }
数量を増減するためにクリックすると、"ADD" または "REMOVE" がディスパッチされます。reducerAction では、数量を更新するために異なる API が呼び出されます。
この例では、アクションの保留中状態を使って、数量と合計金額の両方を置き換えています。数量を即座に更新するなど、即時フィードバックを提供したい場合は、useOptimistic を使用できます。
さらに深く知る
この例は useReducer によく似ていると気付くかもしれませんが、両者は異なる目的を持ちます:
-
UI の state を管理するには
useReducerを使います。リデューサは純粋でなければなりません。 -
アクションの state を管理するには
useActionStateを使います。リデューサは副作用を実行できます。
useActionState は、ユーザアクションから生じる副作用のための useReducer と考えることができます。前回のアクションに基づいて次に実行するアクションを計算するため、呼び出しは直列化する必要があります。アクションを並行して実行したい場合は、useState と useTransition を直接使用してください。
useOptimistic と併用する
useActionState と useOptimistic を組み合わせることで、即時の UI フィードバックを表示できます。
import { useActionState, startTransition, useOptimistic } from 'react'; import { addToCart, removeFromCart } from './api'; import Total from './Total'; export default function Checkout() { const [count, dispatchAction, isPending] = useActionState(updateCartAction, 0); const [optimisticCount, setOptimisticCount] = useOptimistic(count); function handleAdd() { startTransition(() => { setOptimisticCount(c => c + 1); dispatchAction({ type: 'ADD' }); }); } function handleRemove() { startTransition(() => { setOptimisticCount(c => c - 1); dispatchAction({ type: 'REMOVE' }); }); } return ( <div className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <span className="stepper"> <span className="pending">{isPending && '🌀'}</span> <span className="qty">{optimisticCount}</span> <span className="buttons"> <button onClick={handleAdd}>▲</button> <button onClick={handleRemove}>▼</button> </span> </span> </div> <hr /> <Total quantity={optimisticCount} isPending={isPending}/> </div> ); } async function updateCartAction(prevCount, actionPayload) { switch (actionPayload.type) { case 'ADD': { return await addToCart(prevCount); } case 'REMOVE': { return await removeFromCart(prevCount); } } return prevCount; }
setOptimisticCount は数量を即座に更新し、dispatchAction() は updateCartAction をキューに入れます。数量と合計金額の両方に保留中インジケータが表示され、更新がまだ適用中であることをユーザに知らせます。
アクションプロップと併用する
アクションプロップを公開しているコンポーネントに dispatchAction 関数を渡す場合、自分で startTransition や useOptimistic を呼び出す必要はありません。
以下の例では、QuantityStepper コンポーネントの props である increaseAction と decreaseAction を使用しています。
import { useActionState } from 'react'; import { addToCart, removeFromCart } from './api'; import QuantityStepper from './QuantityStepper'; import Total from './Total'; export default function Checkout() { const [count, dispatchAction, isPending] = useActionState(updateCartAction, 0); function addAction() { dispatchAction({type: 'ADD'}); } function removeAction() { dispatchAction({type: 'REMOVE'}); } return ( <div className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <QuantityStepper value={count} increaseAction={addAction} decreaseAction={removeAction} /> </div> <hr /> <Total quantity={count} isPending={isPending} /> </div> ); } async function updateCartAction(prevCount, actionPayload) { switch (actionPayload.type) { case 'ADD': { return await addToCart(prevCount); } case 'REMOVE': { return await removeFromCart(prevCount); } } return prevCount; }
<QuantityStepper> はトランジション、保留中状態、個数の楽観的更新を組み込みでサポートしているため、アクションには何を変更するかを伝えるだけで済み、どのように変更するかは代わりに処理されます。
キューに入ったアクションをキャンセルする
AbortController を使って保留中のアクションをキャンセルできます:
import { useActionState, useRef } from 'react'; import { addToCart, removeFromCart } from './api'; import QuantityStepper from './QuantityStepper'; import Total from './Total'; export default function Checkout() { const abortRef = useRef(null); const [count, dispatchAction, isPending] = useActionState(updateCartAction, 0); async function addAction() { if (abortRef.current) { abortRef.current.abort(); } abortRef.current = new AbortController(); await dispatchAction({ type: 'ADD', signal: abortRef.current.signal }); } async function removeAction() { if (abortRef.current) { abortRef.current.abort(); } abortRef.current = new AbortController(); await dispatchAction({ type: 'REMOVE', signal: abortRef.current.signal }); } return ( <div className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <QuantityStepper value={count} increaseAction={addAction} decreaseAction={removeAction} /> </div> <hr /> <Total quantity={count} isPending={isPending} /> </div> ); } async function updateCartAction(prevCount, actionPayload) { switch (actionPayload.type) { case 'ADD': { try { return await addToCart(prevCount, { signal: actionPayload.signal }); } catch (e) { return prevCount + 1; } } case 'REMOVE': { try { return await removeFromCart(prevCount, { signal: actionPayload.signal }); } catch (e) { return Math.max(0, prevCount - 1); } } } return prevCount; }
増加や減少を複数回クリックして、何度クリックしても合計金額が 1 秒以内に更新されることを確認してください。これは、AbortController を使って前回のアクションを「完了」させ、次のアクションが進めるようにしているためです。
<form> のアクションプロップと併用する
dispatchAction 関数を <form> の action プロパティとして渡すことができます。
このように使う場合、React は送信処理を自動的にトランジションでラップするため、自分で startTransition を呼び出す必要はありません。reducerAction は、前回の state と送信された FormData を受け取ります。
import { useActionState, useOptimistic } from 'react'; import { addToCart, removeFromCart } from './api'; import Total from './Total'; export default function Checkout() { const [count, dispatchAction, isPending] = useActionState(updateCartAction, 0); const [optimisticCount, setOptimisticCount] = useOptimistic(count); async function formAction(formData) { const type = formData.get('type'); if (type === 'ADD') { setOptimisticCount(c => c + 1); } else { setOptimisticCount(c => Math.max(0, c - 1)); } return dispatchAction(formData); } return ( <form action={formAction} className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <span className="stepper"> <span className="pending">{isPending && '🌀'}</span> <span className="qty">{optimisticCount}</span> <span className="buttons"> <button type="submit" name="type" value="ADD">▲</button> <button type="submit" name="type" value="REMOVE">▼</button> </span> </span> </div> <hr /> <Total quantity={count} isPending={isPending} /> </form> ); } async function updateCartAction(prevCount, formData) { const type = formData.get('type'); switch (type) { case 'ADD': { return await addToCart(prevCount); } case 'REMOVE': { return await removeFromCart(prevCount); } } return prevCount; }
この例では、ユーザがステッパの矢印をクリックすると、ボタンがフォームを送信し、useActionState がフォームデータを渡して updateCartAction を呼び出します。この例では、サーバが更新を確認している間、新しい数量を即座に表示するために useOptimistic を使っています。
フォームでアクションを使用する方法について詳しくは、<form> のドキュメントを参照してください。
エラーを処理する
useActionState でエラーを処理する方法は 2 つあります。
バックエンドから返される “quantity not available” のような既知のバリデーションエラーについては、reducerAction の state の一部として返し、UI に表示できます。
undefined is not a function のような未知のエラーについては、エラーをスローできます。React はキューに入っているすべてのアクションをキャンセルし、useActionState フックからエラーを再スローすることで、最も近いエラーバウンダリを表示します。
import {useActionState, startTransition} from 'react'; import {ErrorBoundary} from 'react-error-boundary'; import {addToCart} from './api'; import Total from './Total'; function Checkout() { const [state, dispatchAction, isPending] = useActionState( async (prevState, quantity) => { const result = await addToCart(prevState.count, quantity); if (result.error) { // Return the error from the API as state return {...prevState, error: `Could not add quanitiy ${quantity}: ${result.error}`}; } if (!isPending) { // Clear the error state for the first dispatch. return {count: result.count, error: null}; } // Return the new count, and any errors that happened. return {count: result.count, error: prevState.error}; }, { count: 0, error: null, } ); function handleAdd(quantity) { startTransition(() => { dispatchAction(quantity); }); } return ( <div className="checkout"> <h2>Checkout</h2> <div className="row"> <span>Eras Tour Tickets</span> <span> {isPending && '🌀 '}Qty: {state.count} </span> </div> <div className="buttons"> <button onClick={() => handleAdd(1)}>Add 1</button> <button onClick={() => handleAdd(10)}>Add 10</button> <button onClick={() => handleAdd(NaN)}>Add NaN</button> </div> {state.error && <div className="error">{state.error}</div>} <hr /> <Total quantity={state.count} isPending={isPending} /> </div> ); } export default function App() { return ( <ErrorBoundary fallbackRender={({resetErrorBoundary}) => ( <div className="checkout"> <h2>Something went wrong</h2> <p>The action could not be completed.</p> <button onClick={resetErrorBoundary}>Try again</button> </div> )}> <Checkout /> </ErrorBoundary> ); }
上記の例では、“Add 10” はバリデーションエラーを返す API をシミュレートしており、そのエラーは updateCartAction によって state に保存され、インラインで表示されます。“Add NaN” は無効な個数になるため、updateCartAction がスローします。これは useActionState を通じて ErrorBoundary に伝播し、リセット用 UI が表示されます。
トラブルシューティング
isPending フラグが更新されない
dispatchAction を(アクションプロップ経由ではなく)手動で呼び出している場合、その呼び出しを必ず startTransition でラップしてください。
import { useActionState, startTransition } from 'react';
function MyComponent() {
const [state, dispatchAction, isPending] = useActionState(myAction, null);
function handleClick() {
// ✅ Correct: wrap in startTransition
startTransition(() => {
dispatchAction();
});
}
// ...
}dispatchAction がアクションプロップに渡されている場合、React はそれを自動的にトランジションでラップします。
アクションがフォームデータを読み取れない
useActionState を使う場合、reducerAction は追加の引数として、前回または初期 state を 1 番目の引数に受け取ります。したがって、送信されたフォームデータは 1 番目ではなく 2 番目の引数になります。
// Without useActionState
function action(formData) {
const name = formData.get('name');
}
// With useActionState
function action(prevState, formData) {
const name = formData.get('name');
}アクションがスキップされる
dispatchAction を複数回呼び出したときに一部が実行されない場合、先行する dispatchAction 呼び出しがエラーをスローしたことが原因かもしれません。
reducerAction がスローすると、React はそれ以降にキューに入っているすべての dispatchAction 呼び出しをスキップします。
これに対処するには、reducerAction 内でエラーをキャッチし、スローする代わりにエラー state を返します。
async function myReducerAction(prevState, data) {
try {
const result = await submitData(data);
return { success: true, data: result };
} catch (error) {
// ✅ Return error state instead of throwing
return { success: false, error: error.message };
}
}state がリセットされない
useActionState は組み込みのリセット関数を提供しません。state をリセットするには、リセットシグナルを処理するように reducerAction を設計できます。
const initialState = { name: '', error: null };
async function formAction(prevState, payload) {
// Handle reset
if (payload === null) {
return initialState;
}
// Normal action logic
const result = await submitData(payload);
return result;
}
function MyComponent() {
const [state, dispatchAction, isPending] = useActionState(formAction, initialState);
function handleReset() {
startTransition(() => {
dispatchAction(null); // Pass null to trigger reset
});
}
// ...
}あるいは、useActionState を使っているコンポーネントに key プロパティを追加して新しい state で強制的に再マウントさせるか、送信後に自動的にリセットされる <form> の action プロパティを使うこともできます。
“An async function with useActionState was called outside of a transition.” というエラーが出る
よくある間違いは、dispatchAction をトランジション内から呼び出すのを忘れることです:
action or formAction prop.このエラーが発生するのは、dispatchAction がトランジション内で実行される必要があるためです。
function MyComponent() {
const [state, dispatchAction, isPending] = useActionState(myAsyncAction, null);
function handleClick() {
// ❌ Wrong: calling dispatchAction outside a Transition
dispatchAction();
}
// ...
}修正するには、呼び出しを startTransition でラップします。
import { useActionState, startTransition } from 'react';
function MyComponent() {
const [state, dispatchAction, isPending] = useActionState(myAsyncAction, null);
function handleClick() {
// ✅ Correct: wrap in startTransition
startTransition(() => {
dispatchAction();
});
}
// ...
}あるいは、トランジション内で呼び出されるアクションプロップに dispatchAction を渡します。
function MyComponent() {
const [state, dispatchAction, isPending] = useActionState(myAsyncAction, null);
// ✅ Correct: action prop wraps in a Transition for you
return <Button action={dispatchAction}>...</Button>;
}“Cannot update action state while rendering” というエラーが出る
レンダー中に dispatchAction を呼び出すことはできません:
これは無限ループを引き起こします。dispatchAction を呼び出すと state 更新がスケジュールされ、それが再レンダーをトリガし、その再レンダーでまた dispatchAction が呼び出されるためです。
function MyComponent() {
const [state, dispatchAction, isPending] = useActionState(myAction, null);
// ❌ Wrong: calling dispatchAction during render
dispatchAction();
// ...
}修正するには、フォーム送信やボタンクリックといったユーザイベントに応答する場合にのみ dispatchAction を呼び出すようにしてください。