グローバルオブジェクト

グローバルオブジェクト espar_form の全仕様を以下に示します。(2018.10.09現在)

 

espar_form の全要素

espar_form: {
    "esparフォームID" : {
        // ホスト毎に指定された40桁の英数字文字列。必須
        api_key: "APIキー",

        // デバッグ表示をするかどうか
        debug: true,

        // 複数入力項目を確認画面で表示するときのデリミタ（全項目用と個別項目用）        
        delimiter: ",",
        delimiter_プロパティ名: "<br>",

        // 送信完了画面にフォームを表示し続けるかを定義
        keep_displayed: false,

        // 各種コールバック
        input_ready_callback: function() {...},
        confirm_ready_callback: function() {...},
        validation_failure_callback: function() {...},
        submit_success_callback: function() {...},
        submit_failure_callback:    function() {...},

        // バリデーションエラーが起こった箇所を示す配列
        validation_errors: Array(),

        // フォーム設定をリロードするための関数（espar-form エンジンが追加する）
        reload_form_config: function()
    },

    // ２つ目以降のフォーム
    "esparフォームID2": {
        ...
    }
}

 

各要素の説明

要素	必須	説明
esparフォームID	○	espfで始まる任意の文字列。esparフォームオブジェクトに対するキー。 <form>タグに指定したclass属性に一致している必要がある
api_key	○	弊社より指定したAPIキー。40桁の英数字。ホスト名毎に異なる一位の値
debug		true指定でコンソールログにデバッグ情報を表示
delimiter		チェックボックスや複数選択リストボックスの値を確認画面に表示する時に使用 フォーム内の全ての複数要素に適用。複数の被選択項目の区切り文字
delimiter_[name値]		上記と同じ機能だが、適用する入力要素を明示的に指定する時に仕様する 指定したい要素のname属性の値を指定する
keep_displayed		送信完了時に直前の入力内容確認内容を表示し続ける時にtrueを指定。未指定時はfalse
input_ready_callback		入力画面が表示されきって準備が完了した直後のコールバック関数
confirm_ready_callback		確認画面が表示されきって準備が完了した直後のコールバック関数
validation_failure_callback		入力項目にエラーがあった時にエラーを表示した直後
submit_success_callback		送信が成功して完了した直後のコールバック関数
submit_failure_callback		送信が失敗で終わった直後のコールバック関数
validation_errors		入力項目にエラーがあった時にエラー発生箇所の配列
reload_form_config		フォームの要素が動的に変化した直後に呼び出す必要のある関数。フォーム要素を再評価する関数を格納するプレースホルダとして機能する。フォームの要素が動的に変化しない場合は宣言不要