On this page
d-form
CSRFトークンの自動注入、クライアント側バリデーション、インラインフィールドエラーレンダリング、レスポンスルーティングを備えたAjaxフォームコンテナーです。
1<d-form action="/register" method="POST" rules='{"email": "required|email"}' class="flex-column g-1">2 <input type="email" name="email" placeholder="email address">3 <input type="password" name="password" placeholder="password">4 <button type="submit" class="btn">register</button>5</d-form>
属性とプロパティ(d-form)
| 属性 | プロパティ | 型 | デフォルト値 | フォーム | 説明 |
|---|---|---|---|---|---|
action |
action |
string |
"" |
いいえ | 送信先URL |
method |
method |
string |
"POST" |
いいえ | HTTPリクエストメソッド(GET、POST、PUT、DELETE) |
rules |
rules |
string |
"" |
いいえ | クライアント側バリデーションルールのJSON文字列 |
target |
target |
string |
"" |
いいえ | サーバーがHTMLを返した際に差し替える要素のCSSセレクター |
navigate |
navigate |
boolean |
false |
いいえ | ブラウザー履歴を更新しHTML返却時にSPAルーターを使用 |
force-reload |
forceReload |
string |
"" |
いいえ | リロード条件(""、"true"、"all"、"success"、"error") |
callback |
callback |
string |
"" |
いいえ | レスポンス成功後に実行されるグローバルwindow関数の名前 |
プログラム用api(d-form)
1const form = select('d-form');2 3form.submit();4 5const formData = form.serialize();6 7form.showErrors({ email: ['invalid address'] });8form.clearErrors();9form.setDisabled(true);
イベント(d-form)
| イベント | 詳細 | バブリング | 説明 |
|---|---|---|---|
d-submit |
なし | はい | キャンセル可能、送信開始前に送出 |
d-success |
objectまたはstring |
はい | リクエスト成功時に送出 |
d-error |
object |
はい | リクエスト失敗時またはバリデーションエラー発生時に送出 |
d-response |
objectまたはstring |
はい | すべての完了したレスポンスに対して送出 |
動作仕様(d-form)
- 内部form要素をラップまたは注入しsubmitイベントをインターセプトします。
X-Requested-With: dSPAHttpRequestおよびX-CSRF-TOKENヘッダーを自動注入します。- リクエストの重複を防ぐため送信処理中はすべての入力、ボタン、フォームコントロールを無効化します。
- クライアント側ルールが定義されている場合それを評価します(バリデーション失敗時は送信を中止しインラインフィールドエラーを注入します)。
- ファイルアップロードの場合は
multipart/form-dataを送信します(標準フィールドの場合はapplication/x-www-form-urlencodedを送信します)。
レスポンスライフサイクル
| コントローラーの戻り値 | ステータス / タイプ | デフォルトの動作(force-reloadなし) | force-reload指定時の動作 |
|---|---|---|---|
return json({ data }) |
200 (application/json) |
ペイロードを解析しd-successとd-responseを送出、callbackが定義されている場合は実行、ページリロードなしでフォームを画面に残す |
force-reload、all、またはsuccessが設定されている場合はページをリロード(error指定時は無視) |
return json({ redirect }) |
200 (application/json) |
リロードなしでdSPA.navigate(redirect)を通じて遷移(force: trueまたはX-Redirect-Forceが設定されている場合は完全なページリダイレクトを実行) |
SPAルーター経由で遷移(force: trueの場合はハードリダイレクト) |
return json().withErrors(errors) |
422 (application/json) |
入力欄に.errorを付与しフィールド直下に.error-message(または上部に.error-banner)を注入、d-errorとd-responseを送出 |
force-reload、all、またはerrorが設定されている場合はページをリロード(success指定時はインラインエラーを保持) |
validate() 失敗 |
422 (application/json) |
フィールドバリデーションエラーをインラインでレンダリング、d-errorとd-responseを送出、フォーム状態を維持 |
force-reload、all、またはerrorが設定されている場合はページをリロード(success指定時はインラインエラーを保持) |
return abort(status, message) |
4xxまたは5xx (application/json) |
フォーム上部に.error-bannerを表示、d-errorとd-responseを送出、フォーム入力を再度有効化 |
force-reload、all、またはerrorが設定されている場合はページをリロード(success指定時はバナーを表示) |
return render(view, data) |
200 (text/html) |
返却されたマークアップを対象セレクター(デフォルトはbody)に差し替え、スクリプトを実行、d-successを送出(navigate設定時はURLを更新) |
force-reload、all、またはsuccessが設定されている場合はページをリロード(error指定時は差し替えを実行) |
| 予期しないサーバーエラー | 500 (text/htmlまたはapplication/json) |
HTMLの場合はdocument.writeを通じて完全な500エラーページをレンダリング(JSONの場合はエラーバナーを表示) |
HTMLの場合は500エラーページを表示(JSONの場合はallまたはerror設定時にページをリロード) |
| 予期しない404エラー | 404 (text/htmlまたはapplication/json) |
HTMLの場合は対象を404エラーテンプレートに差し替え(JSONの場合はエラーバナーを表示) | allまたはerrorが設定されている場合はページをリロード(success指定時はビューを保持) |

