jQuery入門道場TOP

jquery.validate.jsの超訳

jquery.validate.jsのvalidateメソッドで使えるオプション部分の超訳を公開しておきます。 時間が取れたら、もっと超訳していきます。 より正確で詳しい説明を確認されたい方は、原文の方へお願いします。

jquery.validate.jsのvalidateメソッドで使えるオプション部分の超訳

debug

trueで、デバッグモードを有効にします(デフォルト:false)。有効の時は、フォームの実際の送信は行われなくなります。また、例えば自作メソッドを指定したのにその自作メソッドを書き忘れている場合などに、Firebugのコンソール画面にエラーメッセージを表示します。

submitHandler

AJAXなどでフォームを送信したい時に、その送信用の関数を指定します。デフォルトのsubmitに取って代わります。(全ての項目がvalidの時のみ呼ばれます)

invalidHandler

送信時にエラーがある際に呼びたいコールバック関数を指定します。

ignore

validation時に、無視したい項目がある際に、その無視するセレクターを指定します。内部的にjQueryの.not()メソッドを使って実装しているので、.not()メソッドで渡せるものを指定します。(デフォルト: ":hidden")

rules

validationするルールを記載します。

messages

個別のエラーメッセージを指定する。

groups

エラーメッセージのグループ化をします。例えば、「姓」と「名」で入力欄は2つに分かれているけど、エラー表示箇所は、1箇所に集約したい場合などに使えます。 任意のグループ名がキーで、グループ化したい項目の名前を半角スペース区切りで指定します。
(訳者コメント)実際のサンプルは、本家サイトでご確認下さい。 任意で指定するグループ名は、特に何かで使われるという訳ではないですね。なお、このサンプルで、groups部分を取ってしまうと、エラーメッセージが2つ表示されてしまったりします。なので、グループ化する必要があるのですね。

onsubmit

submit時にvalidationするかどうか。(デフォルト:true)

onfocusout

blurでvalidationするかどうか(ラジオやチェックボックスは除く)。(デフォルト:true)
(そもそも全く入力していない場合は、validationしません。(既にエラーありと判定されていた場合を除き))

onkeyup

keyupでvalidationするかどうか。(デフォルト:true)

onclick

clickで、ラジオやチェックボックスをvalidationするかどうか。(デフォルト:true)

focusInvalid

submitのエラー時に、「最後にアクティブだった項目」又は「一番最初のエラーのある項目」にフォーカスを戻すかどうか。(デフォルト:true) 「最後にアクティブだった項目」とは、submit時する直前にフォーカスのあった項目を指します。「一番最初のエラーのある項目」とは、エラーがある項目の内の一番最初の項目を指し、sumibt時にフォーカスされていた項目が無い場合は、こちらにフォーカスが戻ります。(trueに設定されていれば)

focusCleanup

エラーをいつまでも出し続けないようにするためのオプションです。(デフォルト:false) 例えば、「名前」「ふりがな」「ニックネーム」と全て必須の際、「名前」を入力しないで、「ふりがな」に移動すれば、名前の欄に「必須です」などとエラーが表示されますが、そのまま「ニックネーム」欄に移動すれば、そのエラーは消えるということです。また、エラーが表示されている項目にフォーカスを合わせると、その時点でエラーも消えます。

meta

必須などのエラーチェック内容は、項目のクラス名からデフォルト読み取りますが、他のプラグインがクラス名を使う際のバッティングを抑える効果があるようです。

errorClass

エラーメッセージの表示の際に使われるクラス名を指定します。(デフォルト:"error")

validClass

validationされ、validと判定された際に、その要素に付加されるクラス名を指定します。(デフォルト:"valid")

errorElement

エラーメッセージを表示する際に使われるタグ名を指定します。(デフォルト:"label")

wrapper

エラーメッセージを表示する際に、そのタグをラップ(包む)したい際に指定します。errorLabelContainer と組み合わせる際に便利です。

errorLabelContainer

エラーを各項目ごとに表示するのではなく、例えばフォームの上部などにまとめて表示したい時に、その表示箇所の要素を指定します。

errorContainer

エラーがある際に表示したい要素を指定します。(エラーが無くなれば非表示になります)

showErros

フォームの入力中に、「今、3個エラーがあります!」というようなエラーを上部などに表示する際に役立ちます。

errorPlacement

個々のエラー表示箇所をカスタマイズする際に使用します。第1引数は、jQueryオブジェクト形式のエラーラベル要素で、第2引数は、jQueryオブジェクト形式のエラーのある要素です。

success

個々の項目ごとにvalidationがOKの時に、エラーラベルを表示します。
文字列を値に指定すれば、それがエラーラベルのクラス名に付加されます。
コールバック関数を指定すれば、jQueryオブジェクト形式のラベル要素を引数にして、関数が実行されます。「入力OK」のような表示をする際に便利です。
(訳者コメント)「エラーラベル」となっていますが、間違いではないです…。

highlight

validationがNGだった際、その項目をどのように表現するかのコールバック関数を指定します。

unhighlight

上記のhighlightで付けられた変更をvalidationがOKになった際、どのように戻すかを指定したコールバック関数を指定します。(引数は、highlightと同じです)

ignoreTitle

title属性からメッセージを読み取るのを辞めるかどうかを指定します。(デフォルト:false) Googleツールバーで起こり得る問題を回避するのに役立ちます。