フィールドとバリデーション

フィールドは任意です。フィールドのないフォームは、フォームから送られたデータを何でも受け付けます。フィールドを公開すると、Ikiform はすべての送信をそれに照らしてサーバーでバリデーションし、不正なデータはわかりやすいメッセージで拒否し、整った型付きの値を保存します。

フィールドを定義する

ダッシュボードでフォームを開き、Fields に移動します。ビジュアルエディターでフィールドを追加するか、JSON の定義を直接編集します。各フィールドの id が、フォームが送るべき入力欄の name です。

{
  "version": 1,
  "title": "Contact",
  "fields": [
    { "id": "name", "type": "text", "label": "Name", "required": true, "validation": { "max_length": 120 } },
    { "id": "email", "type": "email", "label": "Email", "required": true },
    {
      "id": "topic",
      "type": "select",
      "label": "Topic",
      "options": [
        { "value": "sales", "label": "Sales" },
        { "value": "support", "label": "Support" }
      ]
    },
    { "id": "message", "type": "textarea", "label": "Message", "validation": { "min_length": 10 } }
  ],
  "settings": { "submit_label": "Send", "success_message": "Thanks, we'll reply within a day." }
}

定義

トップレベルでも各フィールドでも、不明なキーは拒否されるので、requried のようなタイプミスは保存時にエラーとして表示されます。

すべてのフィールドに共通のキー

プレイグラウンド

{
  "ok": true,
  "id": "sub_01k7v2c9t3e8m5q4x6z0a1b2c3"
}

フィールドタイプ

text

パターンは u フラグ付きで実行され、値全体に一致する必要があります。保存時に、Ikiform は破滅的なバックトラッキングを起こしうるパターンを拒否します。後方参照、繰り返しや選択を含むグループの繰り返し（(a+)+、(a|b)*）、深すぎる繰り返しのネストです。

textarea

email

254 文字を超えるアドレスは拒否されます。ドメイン部分は小文字で保存され、@ より前の部分は送られたとおりに保持されます。

数値

select、radio、multi_select

選択肢にある値だけを受け付けます。select と radio は値を 1 つ受け取ります。multi_select は、繰り返しの名前、name[]、JSON の配列のいずれかで送ります。

checkbox

追加のキーはありません。送られなかったチェックボックスは false になります。required: true はチェックが必須という意味で、同意のチェックボックスに向いています。on、true、1、yes、off、false、0、no、空以外の値は拒否されます。

date

url

ドット付きのホスト名を持ち、ユーザー名やパスワードを含まない http: と https: の URL だけを受け付けます。保存される値は正規化された URL です。

phone

e164 がない場合、電話番号は 6〜15 桁の数字が必要で、送られたとおりに保存されます。e164 がある場合、+1 (415) 555-0123 は +14155550123 として保存されます。

rating

型変換

HTML フォームはすべてをテキストとして送ります。Ikiform は保存する前に、それを各フィールドが宣言した型に変換します。name がテキスト、email、guests が数値、newsletter がチェックボックス、site が URL、phone が電話番号のフィールドの場合:

name=++Ada+Lovelace++&email=Ada@Example.COM&guests=3&newsletter=on&site=example.com&phone=%2B1%20415%20555%200123

{
  "name": "Ada Lovelace",
  "email": "Ada@example.com",
  "guests": 3,
  "newsletter": true,
  "site": "https://example.com/",
  "phone": "+14155550123"
}

• 値の前後の空白は削除されます。空文字列は値なしとみなされます。
• 値を 1 つだけ受け取るフィールドは、2 つ以上の要素を持つ配列を拒否します。
• 数値は、3、-2.5、1e3 のような、64 文字までの通常の小数表記と指数表記を受け付けます。

バリデーションエラー

バリデーションに失敗した送信は 422 validation_failed で拒否され、何も保存されません。error.fields は各フィールド ID をそのメッセージに対応づけます。ブラウザーからの送信では、同じメッセージがフィールドのラベル付きで、ホストされたエラーページに表示されます。

{
  "ok": false,
  "error": {
    "code": "validation_failed",
    "message": "Some fields are invalid.",
    "fields": {
      "email": ["Enter a valid email address"],
      "website": ["Unknown field \"website\""]
    }
  },
  "request_id": "req_01k7v2c9t3e8m5q4x6z0a1b2c3"
}

不明なフィールド

フィールドが定義されている場合、定義にないフィールドは Unknown field "name" として拒否されます。_ で始まる予約済みフィールド、ハニーポット、cf-turnstile-response は対象外です。定義がない場合は、どんなフィールド名でも受け付けます。

メッセージ

ブラウザーでバリデーションする

SDK の validate は、12 種類すべてのフィールドタイプでサーバーのルールとメッセージを再現するので、送信前にエラーを表示できます。正とするのはあくまでサーバーです。validate を参照してください。