| title | <input> |
|---|
ブラウザ組み込みの <input> コンポーネントを利用することで、さまざまな種類のフォーム入力をレンダーすることができます。
<input />入力欄を表示するには、組み込みのブラウザ <input> コンポーネントをレンダーします。
<input name="myInput" /><input> は一般的な要素の props をすべてサポートしています。
formAction: 文字列または関数。type="submit"andtype="image"の場合に親の<form action>を上書きする。actionに URL が渡された場合はフォームは標準的な HTML フォームとして動作する。関数が渡された場合はその関数がフォームの送信を処理する。<form action>を参照。
以下の props を渡すことで、入力欄を制御されたコンポーネント (controlled component) にできます。
checked: ブーリアン。チェックボックスまたはラジオボタンの場合、選択されているかどうかを制御します。value: 文字列。テキスト入力の場合、そのテキストを制御します。（ラジオボタンの場合は、フォームデータを指定します。）
これらのいずれかを渡す場合は、渡された値を更新する onChange ハンドラも渡す必要があります。
以下の <input> の props は、非制御 (uncontrolled) の入力欄にのみ使用されます。
defaultChecked: ブーリアン。type="checkbox"およびtype="radio"の入力欄の場合に、初期値を指定します。defaultValue: 文字列。テキスト入力の場合に、初期値を指定します。
以下の <input> の props は、非制御の入力欄と制御された入力欄の両方で用いられます。
accept: 文字列。type="file"である入力欄が受け付けるファイルの種類を指定します。alt: 文字列。type="image"である入力欄の場合に、代替画像テキストを指定します。capture: 文字列。type="file"である入力欄がキャプチャするメディア（マイク、ビデオ、またはカメラ）を指定します。autoComplete: 文字列。可能なオートコンプリート動作の 1 つを指定します。autoFocus: ブーリアン。trueの場合、React はマウント時にその要素をフォーカスします。dirname: 文字列。要素の文字方向に対するフォームフィールド名を指定します。disabled: ブール値。trueの場合、入力はインタラクティブではなくなり、薄暗く表示されます。children:<input>は子要素を受け取りません。form: 文字列。この入力が属する<form>のidを指定します。省略された場合、最も近い親フォームが対象となります。formAction: 文字列。type="submit"およびtype="image"の場合、親要素の<form action>を上書きします。formEnctype: 文字列。type="submit"およびtype="image"の場合、親要素の<form enctype>を上書きします。formMethod: 文字列。type="submit"およびtype="image"の場合、親要素の<form method>を上書きします。formNoValidate: 文字列。type="submit"およびtype="image"の場合、親要素の<form noValidate>を上書きします。formTarget: 文字列。type="submit"およびtype="image"の場合、<form target>を上書きします。height: 文字列。type="image"の場合、画像の高さを指定します。list: 文字列。オートコンプリートの選択肢を指定する<datalist>のidを指定します。max: 数値。数値および日時タイプの入力欄において最大値を指定します。maxLength: 数値。テキストなどのタイプの入力欄において最大文字数を指定します。min: 数値。数値および日時タイプの入力欄において最小値を指定します。minLength: 数値。テキストなどのタイプの入力欄において最小文字数を指定します。multiple: ブール値。type="file"およびtype="email"の場合、複数の値を許可するかどうかを指定します。name: 文字列。フォームで送信される際に使われるこの入力欄の名前を指定します。onChange:Eventハンドラ関数。制御された入力の場合は必須。ユーザが入力の値を変更するとすぐに発火します（例えば、キーストロークごとに発火します）。ブラウザのinputイベントと同じように動作します。onChangeCapture:onChangeのキャプチャフェーズで発火するバージョン。onInput:Eventハンドラ関数。ユーザが値を変更するとすぐに発火します。歴史的な理由から、React では代わりに同様の動作をするonChangeを使用するのが慣習となっています。onInputCapture:onInputのキャプチャフェーズで発火するバージョン。onInvalid:Eventハンドラ関数。フォームの送信時に入力の検証に失敗した場合に発火します。組み込みのinvalidイベントとは異なり、React のonInvalidイベントはバブルします。onInvalidCapture:onInvalidのキャプチャフェーズで発火するバージョン。onSelect:Eventハンドラ関数。<input>内で選択テキストが変更された後に発火します。React はonSelectイベントを拡張しており、空の選択やテキストの編集（選択に影響を与える可能性がある）でも発火します。onSelectCapture:onSelectのキャプチャフェーズで発火するバージョン。pattern: 文字列。valueがマッチする必要のあるパターンを指定します。placeholder: 文字列。入力値が空の場合、これが薄い色で表示されます。readOnly: ブーリアン。trueの場合、入力欄はユーザによって編集できなくなります。required: ブーリアン。trueの場合、フォームを送信するためには値が必須となります。size: 数値。width の設定と似ていますが、入力欄によって異なる単位で指定します。src: 文字列。type="image"の入力の場合、画像ファイルを指定します。step: 正の数値、または文字列の'any'。有効な値の間隔を指定します。type: 文字列。入力タイプの 1 つ。width: 文字列。type="image"の場合、画像の幅を指定します。
- チェックボックスの場合
value（やdefaultValue）ではなく、checked（やdefaultChecked）が必要です。 - テキスト入力欄が props として文字列型の
valueプロパティを受け取ると、制御されたものとして扱われます。 - チェックボックスまたはラジオボタンが props としてブーリアン型の
checkedを受け取ると、制御されたものとして扱われます。 - 入力欄は制御されたコンポーネントと非制御コンポーネントに同時になることはできません。。
- 入力欄は、ライフタイム中に制御されたコンポーネントから非制御コンポーネント、またはその逆に切り替えることはできません。
- すべての制御された入力欄には、制御に使っている state を同期的に更新するための
onChangeイベントハンドラが必要です。
入力欄を表示するには、<input> コンポーネントをレンダーします。デフォルトではテキスト入力になります。チェックボックスの場合は type="checkbox" を、ラジオボタンの場合は type="radio" を、または他の入力タイプのいずれかを渡すことができます。
export default function MyForm() {
return (
<>
<label>
Text input: <input name="myInput" />
</label>
<hr />
<label>
Checkbox: <input type="checkbox" name="myCheckbox" />
</label>
<hr />
<p>
Radio buttons:
<label>
<input type="radio" name="myRadio" value="option1" />
Option 1
</label>
<label>
<input type="radio" name="myRadio" value="option2" />
Option 2
</label>
<label>
<input type="radio" name="myRadio" value="option3" />
Option 3
</label>
</p>
</>
);
}label { display: block; }
input { margin: 5px; }通常、すべての <input> は <label> タグ内に配置します。これにより、ブラウザに対してこのラベルがその入力欄に関連付けられていることが伝わります。ユーザがラベルをクリックすると、ブラウザは自動的に入力欄にフォーカスします。これはアクセシビリティの観点からも重要です。ユーザが入力欄にフォーカスすると、スクリーンリーダがラベルのキャプションを読み上げます。
もし <label> 内に <input> をネストできない場合は、同じ ID を <input id> と <label htmlFor> に渡すことで関連付けることができます。同一コンポーネントの複数のインスタンス間での競合を避けるために、useId を使用してそのような ID を生成してください。
import { useId } from 'react';
export default function Form() {
const ageInputId = useId();
return (
<>
<label>
Your first name:
<input name="firstName" />
</label>
<hr />
<label htmlFor={ageInputId}>Your age:</label>
<input id={ageInputId} name="age" type="number" />
</>
);
}input { margin: 5px; }オプションで、入力値の初期値を指定することができます。テキスト入力の場合は、defaultValue として文字列を渡してください。チェックボックスとラジオボタンの場合は、代わりにブーリアンの defaultChecked を使用して初期値を指定してください。
export default function MyForm() {
return (
<>
<label>
Text input: <input name="myInput" defaultValue="Some initial value" />
</label>
<hr />
<label>
Checkbox: <input type="checkbox" name="myCheckbox" defaultChecked={true} />
</label>
<hr />
<p>
Radio buttons:
<label>
<input type="radio" name="myRadio" value="option1" />
Option 1
</label>
<label>
<input
type="radio"
name="myRadio"
value="option2"
defaultChecked={true}
/>
Option 2
</label>
<label>
<input type="radio" name="myRadio" value="option3" />
Option 3
</label>
</p>
</>
);
}label { display: block; }
input { margin: 5px; }入力欄を <form> で囲み、その中に <button type="submit"> を配置します。これにより、<form onSubmit> イベントハンドラが呼び出されます。デフォルトでは、ブラウザはフォームデータを現在の URL に送信し、ページを更新します。e.preventDefault() を呼び出すことで、その振る舞いをオーバーライドできます。new FormData(e.target) を使用してフォームデータを読み込みます。
export default function MyForm() {
function handleSubmit(e) {
// Prevent the browser from reloading the page
e.preventDefault();
// Read the form data
const form = e.target;
const formData = new FormData(form);
// You can pass formData as a fetch body directly:
fetch('/some-api', { method: form.method, body: formData });
// Or you can work with it as a plain object:
const formJson = Object.fromEntries(formData.entries());
console.log(formJson);
}
return (
<form method="post" onSubmit={handleSubmit}>
<label>
Text input: <input name="myInput" defaultValue="Some initial value" />
</label>
<hr />
<label>
Checkbox: <input type="checkbox" name="myCheckbox" defaultChecked={true} />
</label>
<hr />
<p>
Radio buttons:
<label><input type="radio" name="myRadio" value="option1" /> Option 1</label>
<label><input type="radio" name="myRadio" value="option2" defaultChecked={true} /> Option 2</label>
<label><input type="radio" name="myRadio" value="option3" /> Option 3</label>
</p>
<hr />
<button type="reset">Reset form</button>
<button type="submit">Submit form</button>
</form>
);
}label { display: block; }
input { margin: 5px; }すべての <input> に name を指定してください。例えば、<input name="firstName" defaultValue="Taylor" /> のように指定します。指定した name は、フォームデータ内のキーとして使用されます。例えば、{ firstName: "Taylor" } のようになります。
デフォルトでは、<form> 内にあり type 属性のない <button> はフォームの送信を行います。これは予想外の挙動かもしれません！ 独自のカスタム Button React コンポーネントを利用している場合は、（type を指定しない）<button> の代わりに <button type="button"> を使うようにすることを考慮してください。そしてフォームを送信することが意図されているボタンには明示的に <button type="submit"> を使用してください。
<input /> のような入力欄は非制御です。<input defaultValue="Initial text" /> のようにデフォルト値を指定している場合でも、この JSX で指定しているのはあくまで初期値であって現在の値ではありません。
制御された入力欄をレンダーするには、value プロパティ（チェックボックスやラジオボタンの場合は checked）を渡してください。React は入力欄が常に渡した value を反映するようにします。通常、state 変数を宣言することで入力欄を制御します。
function Form() {
const [firstName, setFirstName] = useState(''); // Declare a state variable...
// ...
return (
<input
value={firstName} // ...force the input's value to match the state variable...
onChange={e => setFirstName(e.target.value)} // ... and update the state variable on any edits!
/>
);
}例えば編集のたびに UI を再レンダーする必要があるなどの理由でいずれにせよ state が必要な場合、制御された入力欄は特に有用です。
function Form() {
const [firstName, setFirstName] = useState('');
return (
<>
<label>
First name:
<input value={firstName} onChange={e => setFirstName(e.target.value)} />
</label>
{firstName !== '' && <p>Your name is {firstName}.</p>}
...また、制御された入力欄は、入力 state を変更する方法（例えばボタンクリックなど）を複数提供したい場合にも役立ちます。
function Form() {
// ...
const [age, setAge] = useState('');
const ageAsNumber = Number(age);
return (
<>
<label>
Age:
<input
value={age}
onChange={e => setAge(e.target.value)}
type="number"
/>
<button onClick={() => setAge(ageAsNumber + 10)}>
Add 10 years
</button>制御されたコンポーネントに渡す value は、undefined や null であってはなりません。初期値を空にしたい場合（例えば、以下の firstName フィールドのような場合）、state 変数を空の文字列 ('') で初期化してください。
import { useState } from 'react';
export default function Form() {
const [firstName, setFirstName] = useState('');
const [age, setAge] = useState('20');
const ageAsNumber = Number(age);
return (
<>
<label>
First name:
<input
value={firstName}
onChange={e => setFirstName(e.target.value)}
/>
</label>
<label>
Age:
<input
value={age}
onChange={e => setAge(e.target.value)}
type="number"
/>
<button onClick={() => setAge(ageAsNumber + 10)}>
Add 10 years
</button>
</label>
{firstName !== '' &&
<p>Your name is {firstName}.</p>
}
{ageAsNumber > 0 &&
<p>Your age is {ageAsNumber}.</p>
}
</>
);
}label { display: block; }
input { margin: 5px; }
p { font-weight: bold; }onChange を指定せずに value を渡すと、入力欄に入力することができなくなります。入力欄に value を渡して制御を行うと、渡した値で入力欄を強制的に固定することになります。したがって、state 変数を value として渡しても、onChange イベントハンドラ内でその state 変数を同期的に更新するのを忘れた場合、React は入力欄を、キーストローク毎に指定した value に戻してしまいます。
制御された入力欄を使用する場合、キーストロークごとに state のセットが行われます。state を含んだコンポーネントが大きなツリーを再レンダーする場合、速度が遅くなる可能性があります。再レンダー時のパフォーマンスを最適化する方法がいくつかあります。
例えば、キーストロークごとにページ内コンテンツをすべて再レンダーするフォームがあるとしましょう。
function App() {
const [firstName, setFirstName] = useState('');
return (
<>
<form>
<input value={firstName} onChange={e => setFirstName(e.target.value)} />
</form>
<PageContent />
</>
);
}<PageContent /> は入力値の state に依存していないため、入力値 state を独立したコンポーネントに移動できます。
function App() {
return (
<>
<SignupForm />
<PageContent />
</>
);
}
function SignupForm() {
const [firstName, setFirstName] = useState('');
return (
<form>
<input value={firstName} onChange={e => setFirstName(e.target.value)} />
</form>
);
}これにより、キーストロークごとに SignupForm のみが再レンダーされるため、パフォーマンスが大幅に向上します。
再レンダーを回避する方法がない場合（例えば、PageContent が検索ボックスの入力値に依存する場合）、useDeferredValue を使用することで、巨大な再レンダーの途中でも、制御された入力欄の応答性を維持できます。
value があるが onChange のない入力欄をレンダーすると、コンソールにエラーが表示されます。
// 🔴 Bug: controlled text input with no onChange handler
<input value={something} />You provided a value prop to a form field without an onChange handler. This will render a read-only field. If the field should be mutable use defaultValue. Otherwise, set either onChange or readOnly.
エラーメッセージが示すように、初期値を指定したいだけの場合は、代わりに defaultValue を渡すようにしてください。
// ✅ Good: uncontrolled input with an initial value
<input defaultValue={something} />state 変数でこの入力欄を制御したい場合は、onChange ハンドラを指定してください。
// ✅ Good: controlled input with onChange
<input value={something} onChange={e => setSomething(e.target.value)} />値を意図的に読み取り専用にしたい場合は、エラーを抑制するために props として readOnly を追加してください。
// ✅ Good: readonly controlled input without on change
<input value={something} readOnly={true} />checked があるが onChange のないチェックボックスをレンダーすると、コンソールにエラーが表示されます。
// 🔴 Bug: controlled checkbox with no onChange handler
<input type="checkbox" checked={something} />You provided a checked prop to a form field without an onChange handler. This will render a read-only field. If the field should be mutable use defaultChecked. Otherwise, set either onChange or readOnly.
エラーメッセージが示すように、初期値を指定したいだけの場合は、代わりに defaultChecked を渡すようにしてください。
// ✅ Good: uncontrolled checkbox with an initial value
<input type="checkbox" defaultChecked={something} />state 変数でこのチェックボックスを制御したい場合は、onChange ハンドラを指定してください。
// ✅ Good: controlled checkbox with onChange
<input type="checkbox" checked={something} onChange={e => setSomething(e.target.checked)} />チェックボックスの場合は、e.target.value ではなく e.target.checked を読み取る必要があります。
チェックボックスを意図的に読み取り専用にしたい場合は、エラーを抑制するために props として readOnly を追加してください。
// ✅ Good: readonly controlled input without on change
<input type="checkbox" checked={something} readOnly={true} />入力欄を制御する場合、onChange 中でその state 変数を DOM からやってくる入力欄の値に更新する必要があります。
state を e.target.value（チェックボックスの場合は e.target.checked）以外のものに更新することはできません。
function handleChange(e) {
// 🔴 Bug: updating an input to something other than e.target.value
setFirstName(e.target.value.toUpperCase());
}また、非同期に更新することもできません。
function handleChange(e) {
// 🔴 Bug: updating an input asynchronously
setTimeout(() => {
setFirstName(e.target.value);
}, 100);
}コードを修正するには、state を e.target.value の値に同期的に更新します。
function handleChange(e) {
// ✅ Updating a controlled input to e.target.value synchronously
setFirstName(e.target.value);
}これで問題が解決しない場合、入力欄がキーストロークごとに DOM から削除・再追加されている可能性があります。これは、再レンダーごとに state を誤ってリセットしている場合に起こります。例えば、入力欄またはその親が常に異なる key 属性を受け取っている可能性や、コンポーネント定義をネストしている（これは React では許されておらず、「内側」のコンポーネントがレンダー時に再マウントさえることになります）可能性があります。
"A component is changing an uncontrolled input to be controlled" というエラーが発生する {/im-getting-an-error-a-component-is-changing-an-uncontrolled-input-to-be-controlled/}
コンポーネントに value を渡す場合、そのライフサイクル全体を通じて文字列型でなければなりません。
最初に value={undefined} を渡しておき、後で value="some string" を渡すようなことはできません。なぜなら、React はあなたがコンポーネントを非制御コンポーネントと制御されたコンポーネントのどちらにしたいのか分からなくなるからです。制御されたコンポーネントは常に文字列の value を受け取るべきであり、null や undefined であってはいけません。
あなたの value が API や state 変数から来ている場合、それが null や undefined に初期化されているかもしれません。その場合、まず空の文字列（''）にセットするか、value が文字列であることを保証するために value={someValue ?? ''} を渡すようにしてください。
同様に、チェックボックスに checked を渡す場合は、常にブーリアン型であることを確認してください。