面對表單的驗證,自己寫大量的js畢竟不是一個明智的做法。不僅僅是代碼很長而且不便於梳理。Validform就是一款開源的第三方驗證js的控件,通過添加相應的js以及css能夠有效的驗證表單,維護起來也很方便。這篇文章就是針對我對validform的理解真理的一篇validform的使用文檔。Validform官網
1、js和css的引用:
這里引用官網下載中的一下css:
(文件里這個注釋 "/*==========以下部分是Validform必須的===========*/" 之后的部分是必須的)
畢竟validform是基於jquery編寫的,所以這個地方也需要引用Jquery腳本;
<script type="text/javascript" src="http://validform.rjboy.cn/wp-content/themes/validform/js/jquery-1.6.2.min.js"></script> <script type="text/javascript" src="http://validform.rjboy.cn/Validform/v5.1/Validform_v5.1_min.js"></script>
2、表單元素的屬性綁定:
表單元素的屬性主要有:datatype、nullmsg、sucmsg、errormsg、ignore、recheck、tip、altercss、ajaxurl 和 plugin;
2.1:datatype:
內置基本的datatype類型有: * | *6-16 | n | n6-16 | s | s6-18 | p | m | e | url
*:檢測是否有輸入,可以輸入任何字符,不留空即可通過驗證;
*6-16:檢測是否為6到16位任意字符;
n:數字類型;
n6-16:6到16位數字;
s:字符串類型;
s6-18:6到18位字符串;
p:驗證是否為郵政編碼;
m:手機號碼格式;
e:email格式;
url:驗證字符串是否為網址。
自定義datatype的名稱,可以由字母、數字、下划線、中划線和*號組成。
形如"*6-16"的datatype,Validform會自動擴展,可以指定任意的數值范圍。如內置基本類型有"*6-16",那么你綁定datatype="*4-12"就表示4到12位任意字符。如果你自定義了一個datatype="zh2-4",表示2到4位中文字符,那么datatype="zh2-6"就表示2到6位中文字符。
5.2版本之后,datatype支持規則累加或單選。用","分隔表示規則累加;用"|"分隔表示規則多選一,即只要符合其中一個規則就可以通過驗證,綁定的規則會依次驗證,只要驗證通過,后面的規則就會忽略不再比較。如綁定datatype="m|e",表示既可以填寫手機號碼,也能填寫郵箱地址,如果知道填入的是手機號碼,那么就不會再檢測他是不是郵箱地址;datatype="zh,s2-4",表示要符合自定義類型"zh",也要符合規則"s2-4"。
注:
5.2.1版本之后,datatype支持:
直接綁定正則:如可用這樣寫datatype="/\w{3,6}/i",要求是3到6位的字母,不區分大小寫;
支持簡單的邏輯運算:如datatype="m | e, *4-18 | /\w{3,6}/i | /^validform\.rjboy\.cn$/",
這個表達式的意思是:可以是手機號碼;或者是郵箱地址,但字符長度必須在4到18位;或者是3到6位的字母,不區分大小寫;或者輸入validform.rjboy.cn,區分大小寫。這里","分隔相當於邏輯運算里的"&&"; "|"分隔相當於邏輯運算里的"||";不支持括號運算。
2.2、nullmsg:
當表單元素值為空時的提示信息,不綁定,默認提示"請填入信息!"。如:nullmsg="請填寫用戶名!"
2.3、sucmsg :
當表單元素通過驗證時的提示信息,不綁定,默認提示"通過信息驗證!"。如:sucmsg="用戶名還未被使用,可以注冊!"
2.4、errormsg:
輸入內容不能通過驗證時的提示信息,默認提示"請輸入正確信息!"。如:errormsg="用戶名必須是2到4位中文字符!"
2.5、ignore:
綁定了ignore="ignore"的表單元素,在有輸入時,會驗證所填數據是否符合datatype所指定數據類型,沒有填寫內容時則會忽略對它的驗證;
2.6、rechec:
表單里面經常需要檢查兩次密碼輸入是否一致,recheck就是用來指定需要比較的另外一個表單元素。如:recheck="password1",那么它就會拿當前元素的值跟該表單下,name為"password1"的元素比較。
2.7、tip:
表單里經常有些文本框需要默認就顯示一個灰色的提示文字,當獲得焦點時提示文字消失,失去焦點時提示文字顯示。tip屬性就是用來實現這個效果。它通常和altercss搭配使用。如<input type="text" value="默認提示文字" class="gray intxt" tip="默認提示文字" altercss="gray" />
2.8、altercss:
它需要和tip屬性配合使用,altercss指定的樣式名,會在文本框獲得焦點時被刪除,沒有輸入內容而失去焦點時重新加上。
2.9、ajaxurl:
指定ajax實時驗證的后台文件的地址。后台頁面如valid.php文件中可以用 $_POST["param"] 接收到值,Ajax中會POST過來變量param和name。param是文本框的值,name是文本框的name屬性。
2.10、plugin:
指定需要使用的插件。5.3版開始,對於日期、swfupload和密碼強度檢測這三個插件,綁定了plugin屬性即可以初始化對應的插件,可以不用在validform初始化時傳入空的usePlugi了。
舉例如下:
<!--ajax實時驗證用戶名--> <input type="text" value="" name="name" datatype="e" ajaxurl="valid.php?myparam1=value1&myparam2=value2" sucmsg="用戶名驗證通過!" nullmsg="請輸入用戶名!" errormsg="請用郵箱或手機號碼注冊!" /> <!--密碼--> <input type="password" value="" name="userpassword" datatype="*6-15" errormsg="密碼范圍在6~15位之間!" /> <!--確認密碼--> <input type="password" value="" name="userpassword2" datatype="*" recheck="userpassword" errormsg="您兩次輸入的賬號密碼不一致!" /> <!--默認提示文字--> <textarea tip="請在這里輸入您的意見。" errormsg="很感謝您花費寶貴時間給我們提供反饋,請填寫有效內容!" datatype="s" altercss="gray" class="gray" name="msg" value="">請在這里輸入您的意見。</textarea> <!--使用swfupload插件--> <input type="text" plugin="swfupload" class="inputxt" disabled="disabled" value=""> <input type="hidden" value="" pluginhidden="swfupload"> <!--使用passwordStrength插件--> <input type="password" errormsg="密碼至少6個字符,最多18個字符!" datatype="*6-18" plugin="passwordStrength" class="inputxt" name="password" value=""> <div class="passwordStrength" style="display:none;"><b>密碼強度:</b> <span>弱</span><span>中</span><span class="last">強</span></div> <!--使用DatePicker插件--> <input type="text" plugin="datepicker" class="inputxt" name="birthday" value="">
初始化參數說明:
參數說明:【所有參數均為可選項】
- 必須是表單對象執行Validform方法,示例中".demoform"就是綁定在form元素上的class名稱;
- btnSubmit
指定當前表單下的哪一個按鈕觸發表單提交事件,如果表單下有submit按鈕時可以省略該參數。示例中".btn_sub"是該表單下要綁定點擊提交表單事件的按鈕; - btnReset
".btn_reset"是該表單下要綁定點擊重置表單事件的按鈕; - tiptype
可用的值有:1、2、3、4和function函數,默認tiptype為1。 3、4是5.2.1版本新增
1=> 自定義彈出框提示;
2=> 側邊提示(會在當前元素的父級的next對象的子級查找顯示提示信息的對象,表單以ajax提交時會彈出自定義提示框顯示表單提交狀態);
3=> 側邊提示(會在當前元素的siblings對象中查找顯示提示信息的對象,表單以ajax提交時會彈出自定義提示框顯示表單提交狀態);
4=> 側邊提示(會在當前元素的父級的next對象下查找顯示提示信息的對象,表單以ajax提交時不顯示表單的提交狀態);
如果上面的4種提示方式不是你需要的,你可以給tiptype傳入自定義函數。通過自定義函數,可以實現你想要的任何提示效果:
tiptype:function(msg,o,cssctl){ //msg:提示信息; //o:{obj:*,type:*,curform:*}, //obj指向的是當前驗證的表單元素(或表單對象,驗證全部驗證通過,提交表單時o.obj為該表單對象), //type指示提示的狀態,值為1、2、3、4, 1:正在檢測/提交數據,2:通過驗證,3:驗證失敗,4:提示ignore狀態, //curform為當前form對象; //cssctl:內置的提示信息樣式控制函數,該函數需傳入兩個參數:顯示提示信息的對象 和 當前提示的狀態(既形參o中的type); } 具體參見demo頁。
tiptype不為1時,Validform會查找class為"Validform_checktip"的標簽顯示提示信息。tiptype=1時,會自動創建彈出框顯示提示信息。
Validform_checktip和表單元素之間的位置關系,會根據tiptype的值有對應的結構,上面已經做了說明。
5.3版本開始,如果頁面里沒有顯示出錯信息的標簽,會根據tiptype值自動創建Validform_checktip對象。 - ignoreHidden
可用值: true | false。
默認為false,當為true時對:hidden的表單元素將不做驗證; - dragonfly
可用值: true | false。
默認false,當為true時,值為空時不做驗證; - tipSweep
可用值: true | false。
默認為false, 5.3版中做了修正,在各種tiptype下, 為true時提示信息將只會在表單提交時觸發顯示,各表單元素blur時不會觸發信息提示; - label 5.3.1+
選擇符
在沒有綁定nullmsg時查找要顯示的提示文字,默認查找".Validform_label"下的文字; - showAllError
可用值: true | false。
默認為false,true:提交表單時所有錯誤提示信息都會顯示;false:一碰到驗證不通過的對象就會停止檢測后面的元素,只顯示該元素的錯誤信息; - postonce
可用值: true | false。
默認為false,指定是否開啟二次提交防御,true開啟,不指定則默認關閉;
為true時,在數據成功提交后,表單將不能再繼續提交。 - ajaxPost
可用值: true | false。
默認為false,使用ajax方式提交表單數據,將會把數據POST到config方法或表單action屬性里設定的地址; - datatype
傳入自定義datatype類型,可以是正則,也可以是函數。
datatyp:{ "zh2-4":/^[\u4E00-\u9FA5\uf900-\ufa2d]{2,4}$/, "phone":function(gets,obj,curform,regxp){ //參數gets是獲取到的表單元素值, //obj為當前表單元素, //curform為當前驗證的表單, //regxp為內置的一些正則表達式的引用。 //return false表示驗證出錯,沒有return或者return true表示驗證通過。 } }
具體示例請參考demo頁; - usePlugin
目前已整合swfupload、datepicker、passwordstrength和jqtransform四個插件,在這里傳入這些插件使用時需要傳入的參數。datepicker在Validform內調用時另外擴展了幾個比較實用的參數,具體請參考demo頁; - beforeCheck(curform)
在表單提交執行驗證之前執行的函數,curform參數獲取到的是當前表單對象。
函數return false的話將不會繼續執行驗證操作; - beforeSubmit(curform)
在表單驗證通過,提交表單數據之前執行的函數,data參數是當前表單對象。
函數return false的話表單將不會提交; - callback
在使用ajax提交表單數據時,數據提交后的回調函數。返回數據data是Json對象:
{"info":"demo info","status":"y"}
info: 輸出提示信息,
status: 返回提交數據的狀態,是否提交成功,"y"表示提交成功,"n"表示提交失敗,在ajax_post.php文件返回數據里自定字符,主要用在callback函數里根據該值執行相應的回調操作。你也可以在ajax_post.php文件返回更多信息在這里獲取,進行相應操作;
如果不是ajax方式提交表單,傳入callback,這時data參數是當前表單對象,回調函數會在表單驗證全部通過后執行,然后判斷是否提交表單,如果callback里return false,則表單不會提交,如果return true或沒有return,則會提交表單。
5.3版開始,ajax遇到服務端錯誤時也會執行回調,這時的data是{ status:**, statusText:**, readyState:**, responseText:** }
初始化舉例代碼如下:
$(".demoform").Validform({ btnSubmit:"#btn_sub", btnReset:".btn_reset", tiptype:1, ignoreHidden:false, dragonfly:false, tipSweep:true, label:".label", showAllError:false, postonce:true, ajaxPost:true, datatype:{ "*6-20": /^[^\s]{6,20}$/, "z2-4" : /^[\u4E00-\u9FA5\uf900-\ufa2d]{2,4}$/, "username":function(gets,obj,curform,regxp){ //參數gets是獲取到的表單元素值,obj為當前表單元素,curform為當前驗證的表單,regxp為內置的一些正則表達式的引用; var reg1=/^[\w\.]{4,16}$/, reg2=/^[\u4E00-\u9FA5\uf900-\ufa2d]{2,8}$/; if(reg1.test(gets)){return true;} if(reg2.test(gets)){return true;} return false; //注意return可以返回true 或 false 或 字符串文字,true表示驗證通過,返回字符串表示驗證失敗,字符串作為錯誤提示顯示,返回false則用errmsg或默認的錯誤提示; }, "phone":function(){ // 5.0 版本之后,要實現二選一的驗證效果,datatype 的名稱 不 需要以 "option_" 開頭; } }, usePlugin:{ swfupload:{}, datepicker:{}, passwordstrength:{}, jqtransform:{ selector:"select,input" } }, beforeCheck:function(curform){ //在表單提交執行驗證之前執行的函數,curform參數是當前表單對象。 //這里明確return false的話將不會繼續執行驗證操作; }, beforeSubmit:function(curform){ //在驗證成功后,表單提交前執行的函數,curform參數是當前表單對象。 //這里明確return false的話表單將不會提交; }, callback:function(data){ //返回數據data是json對象,{"info":"demo info","status":"y"} //info: 輸出提示信息; //status: 返回提交數據的狀態,是否提交成功。如可以用"y"表示提交成功,"n"表示提交失敗,在ajax_post.php文件返回數據里自定字符,主要用在callback函數里根據該值執行相應的回調操作; //你也可以在ajax_post.php文件返回更多信息在這里獲取,進行相應操作; //ajax遇到服務端錯誤時也會執行回調,這時的data是{ status:**, statusText:**, readyState:**, responseText:** }; //這里執行回調操作; //注意:如果不是ajax方式提交表單,傳入callback,這時data參數是當前表單對象,回調函數會在表單驗證全部通過后執行,然后判斷是否提交表單,如果callback里明確return false,則表單不會提交,如果return true或沒有return,則會提交表單。 } });
Validform對象:
如示例 var demo=$(".formsub").Validform(),那么demo對象會有以下屬性和方法可以調用:
tipmsg【object】
如:demo.tipmsg.s="error! no message inputed.";
通過該對象可以修改除 tit 以外的其他提示文字,這樣可以實現同一個頁面的不同表單使用不同的提示文字。
具體可修改的提示文字
$.Tipmsg={//默認提示文字;
tit:"提示信息",
w:{
"*":"不能為空!",
"*6-16":"請填寫6到16位任意字符!",
"n":"請填寫數字!",
"n6-16":"請填寫6到16位數字!",
"s":"不能輸入特殊字符!",
"s6-18":"請填寫6到18位字符!",
"p":"請填寫郵政編碼!",
"m":"請填寫手機號碼!",
"e":"郵箱地址格式不對!",
"url":"請填寫網址!"
},
def:"請填寫正確信息!",
undef:"datatype未定義!",
reck:"兩次輸入的內容不一致!",
r:"通過信息驗證!",
c:"正在檢測信息…",
s:"請{填寫|選擇}{0|信息}!",
v:"所填信息沒有經過驗證,請稍后…",
p:"正在提交數據…"
};
要修改tit(彈出框的標題文字)的話,可以這樣:$.Tipmsg.tit="Message Box",則彈出框的標題文字會換成"Message Box"
注:5.3.2+
$.Tipmsg.w里,形如"*6-16"的提示文字,里面的數字是會被替換的。如綁定datatype="*2-18",那它默認的出錯信息就會是"請填寫2到18位任意字符!",可以通過$.Tipmsg.w或Validform對象的tipmsg屬性修改和擴展默認錯誤信息,如果你已經設置了"zh2-4"的提示信息是"2-4位中文",那么"zh2-8"出錯的信息就自動會是:"2-8位中文"。對於自定義的datatype,在擴展默認信息時,注意錯誤信息的名字要跟datatype名字一樣,如上面示例是:$.Tipmsg.w["zh2-4"]="2-4位中文"。對於多頁面或一個頁面多表單有相同datatype來說,在$.Tipmsg.w或Validform對象的tipmsg屬性中擴展默認提示信息是個很好的選擇。
5.3.1+
$.Tipmsg.s是用來指定在沒有綁定nullmsg時的默認提示信息。"{0}"是會被找到的label參數指定的對象或Validform_label里的文字替換掉的,"{填寫|選擇}"里的文字在綁定了"recheck"屬性的表單元素上檢測時是會不顯示的,當前驗證對象是radio、checkbox或select時,會輸出"選擇",是其他類型的元素時會輸出"填寫"和后面的"信息"。
具體示例請參見demo頁。
dataType【object】
獲取內置的一些正則:
{
"match":/^(.+?)(\d+)-(\d+)$/,
"*":/[\w\W]+/,
"*6-16":/^[\w\W]{6,16}$/,
"n":/^\d+$/,
"n6-16":/^\d{6,16}$/,
"s":/^[\u4E00-\u9FA5\uf900-\ufa2d\w\.\s]+$/,
"s6-18":/^[\u4E00-\u9FA5\uf900-\ufa2d\w\.\s]{6,18}$/,
"p":/^[0-9]{6}$/,
"m":/^13[0-9]{9}$|14[0-9]{9}|15[0-9]{9}$|18[0-9]{9}$/,
"e":/^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$/,
"url":/^(\w+:\/\/)?\w+(\.\w+)+.*$/
}
addRule(rule)【返回值:Validform】
可以通過Validform對象的這個方法來給表單元素綁定驗證規則,綁定驗證類型中列出的附加屬性都可以通過這個方法綁定。
demo.addRule([
{
ele:"#name",
datatype:"s6-18",
ajaxurl:"valid.php",
nullmsg:"請輸入昵稱!",
errormsg:"昵稱至少6個字符,最多18個字符!"
},
{
ele:"#userpassword",
datatype:"*6-16",
nullmsg:"請設置密碼!",
errormsg:"密碼范圍在6~16位之間!"
},
{
ele:"#userpassword2",
datatype:"*",
recheck:"userpassword",
nullmsg:"請再輸入一次密碼!",
errormsg:"您兩次輸入的賬號密碼不一致!"
}
]);
其中ele是指定要綁定規則的對象,會在Validform對象下查找這些對象。
eq(n)【返回值:Validform】
獲取Validform對象的第n個元素。
如你頁面上有多個form的class都是formsub,執行上面的驗證綁定,得到的demo對象就可以操作所有這些表單,如果你要對其中某個表單執行某些操作,那么就可以使用這個方法。
如demo.eq(0).resetForm(),重置第一個表單。
ajaxPost(flag,sync,url)【返回值:Validform】
以ajax方式提交表單。flag為true時,跳過驗證直接提交,sync為true時將以同步的方式進行ajax提交。
參數url是5.3版新增,傳入了url地址時,表單會提交到這個地址
如demo.ajaxPost(true),不做驗證直接ajax提交表單。
abort()【返回值:Validform】
終止ajax的提交。
如執行上面的ajaxPost()之后,發現某些項填寫不對,想取消表單提交,那么就可以執行這個操作:demo.abort()
submitForm(flag,url)【返回值:Validform】
以初始化時傳入參數的設置方式提交表單,flag為true時,跳過驗證直接提交。
參數url是5.3版新增,傳入了url地址時,表單會提交到這個地址
如demo.submitForm(true),不做驗證直接提交表單。
resetForm()【返回值:Validform】
重置表單。
如demo.resetForm(),重置表單到初始狀態。
resetStatus()【返回值:Validform】
重置表單的提交狀態。傳入了postonce參數的話,表單成功提交后狀態會設置為"posted",重置提交狀態可以讓表單繼續可以提交。
如demo.resetStatus()
getStatus()【返回值:String】
獲取表單的提交狀態,normal:未提交,posting:正在提交,posted:已成功提交過。
如demo.getStatus()
setStatus(status)【返回值:Validform】
設置表單的提交狀態,可以設置normal,posting,posted三種狀態,不傳參則設置狀態為posting,這個狀態表單可以驗證,但不能提交。
如demo.setStatus("posted")
ignore(selector)【返回值:Validform】
忽略對所選擇對象的驗證,不傳入selector則忽略所有表單元素。
如demo.ignore("select,textarea,#name"),忽略Validform對象下所有select,textarea及一個id為"name"元素的驗證。
unignore(selector)【返回值:Validform】
將ignore方法所忽略驗證的對象重新獲取驗證效果,不傳入selector則恢復驗證所有表單元素。
如demo.unignore("select,textarea,#name"),恢復Validform對象下所有select,textarea及一個id為"name"元素的驗證。
check(bool,selector)【返回值:Boolean】
bool為true時則只驗證不顯示提示信息
對指定對象進行驗證(默認驗證當前整個表單),通過返回true,否則返回false(綁定實時驗證的對象,格式符合要求時返回true,而不會等ajax的返回結果)
如demo.check(),驗證當前整個表單,且只驗證但不顯示對錯信息。
config(setup) 5.3+ 【返回值:Validform】
setup參數是一個對象。
如:
demo.config({
showAllError:true,
url:"這里指定提交地址",
ajaxpost:{
//可以傳入$.ajax()能使用的,除dataType外的所有參數;
},
ajaxurl:{
//可以傳入$.ajax()能使用的,除dataType外的所有參數;
}
})
可用參數:
tiptype等 5.3.2+:可以在這里設置初始化可用的所有參數 url:指定表單的提交路徑,這里指定的路徑會覆蓋表單action屬性所指定的路徑 ajaxpost:表單以ajax提交時,可以在這里配置ajax的參數 ajaxurl:配置實時驗證ajax的參數 ①、config方法還能為已經初始化過的表單重新配置參數了!5.3.2+ 如var demo=$(".formsub").Validform(); demo.config({tiptype:2}); demo下的各表單還能分別配置不同參數! 如demo.eq(0).config({tiptype:1,ajaxPost:true}); demo.eq(1).config({tiptype:1,callback:function(curform){my_method_to_submit_form(); return false;}}); ②、執行config可以動態設置、添加參數,如: demo.config({ url:"http://validform.rjboy.cn" }); $(".save").click(function(){ demo.config({ ajaxpost:{ timeout:1000 } }); }); 那么在點擊save按鈕后,demo所對應的表單的config={ url:"http://validform.rjboy.cn", ajaxpost:{ timeout:1000 } } ③、參數url的優先級:form表單的action所指定的提交地址會被config.url覆蓋, config.url會被config.ajaxpost.url覆蓋,config.ajaxpost.url會被Validform對象的方法submitForm(flag,url) 和ajaxPost(flag,sync,url)里的url覆蓋。 如果表單里沒有指定action提交地址,那么就會提交到config.url設定的地址。 考慮到整個驗證框架的邏輯,傳入dataType參數不會起作用,不會被覆蓋,ajax必須返回含有status值的json數據。 ④、另外注意的是:傳入的success和error方法里,能多獲取到一個參數,如: demo.config={ ajaxpost:{ url:"", timeout:1000, ..., success:function(data,obj){ //data是返回的json數據; //obj是當前表單的jquery對象; }, error:function(data,obj){ //data是{ status:**, statusText:**, readyState:**, responseText:** }; //obj是當前表單的jquery對象; } }, ajaxurl:{ success:function(data,obj){ //data是返回的json數據; //obj是當前正做實時驗證表單元素的jquery對象; //注意:5.3版中,實時驗證的返回數據須是含有status值的json數據! //跟callback里的ajax返回數據格式統一,建議不再返回字符串"y"或"n"。目前這兩種格式的數據都兼容。 } } }