DIV CSS 佈局教程網

用 jQuery 做日期輸入格式化控件:自動補「____-__-__」
編輯:JavaScript綜合知識     

日期輸入框如果放任使用者自由輸入,就會收到「2013-9-1」、「2013/09/01」、「130901」各種格式,後端只好寫一堆判斷。解法是在輸入框裡預先放好格式骨架「____-__-__」,讓使用者只能往空位填數字。本文分享這個思路與完整實作。

先來看效果:

HTML

日期: <input type="text" id="dateInputer" class="hhm-dateInputer" placeholder="請輸入日期">

透過 hhm-dateInputer 這個 class 來綁定控件,這樣同一頁面上就能有多個日期輸入框。

引入 jQuery

主要用來選取元素與綁定事件:

<script src="https://code.jquery.com/jquery-1.9.1.min.js"></script>

游標操作的工具函數

因為整個控件會大量讀寫游標位置與選取範圍,先把四個工具函數準備好。每個都必須同時照顧標準 API 與 IE 6/7/8 的 TextRange:

// 取得游標位置
function getCursor(elem) {
  // IE 9、10 與其他瀏覽器
  if (elem.selectionStart !== undefined) {
    return elem.selectionStart;
  } else { // IE 6,7,8
    var range = document.selection.createRange();
    range.moveStart("character", -elem.value.length);
    return range.text.length;
  }
}

// 設定游標位置
function setCursor(elem, index) {
  if (elem.selectionStart !== undefined) {
    elem.selectionStart = index;
    elem.selectionEnd = index;
  } else { // IE 6,7,8
    var range = elem.createTextRange();
    range.moveStart("character", -elem.value.length); // 左邊界移到起點
    range.move("character", index);                   // 游標放到 index
    range.select();
  }
}

// 取得選中的文字
function getSelection(elem) {
  if (elem.selectionStart !== undefined) {
    return elem.value.substring(elem.selectionStart, elem.selectionEnd);
  } else {
    var range = document.selection.createRange();
    return range.text;
  }
}

// 設定選取範圍
function setSelection(elem, leftIndex, rightIndex) {
  if (elem.selectionStart !== undefined) {
    elem.selectionStart = leftIndex;
    elem.selectionEnd = rightIndex;
  } else { // IE 6,7,8
    var range = elem.createTextRange();
    range.move("character", -elem.value.length);
    // 這裡必須先 moveEnd 再 moveStart,
    // 因為若左邊界超過右邊界,瀏覽器會自動讓右邊界等於左邊界
    range.moveEnd("character", rightIndex);
    range.moveStart("character", leftIndex);
    range.select();
  }
}

設計思路

先找到 class 為 hhm-dateInputer 的元素,綁定三個事件:focus、blur、keydown。

focus:若內容為空,就填入初始值「____-__-__」,並把游標移到第一個下劃線前面。

blur:若內容仍是初始骨架(使用者什麼都沒填),就清空為空字串,避免送出無意義的值。

keydown:這裡刻意用 keydown 而不是 keyup。差別在於 keydown 觸發時按下的字符還沒進到輸入框,我們因此有機會阻止不合法的字符。判斷分三支:

1. keyCode 在 48~57 之間代表數字:把游標位置的那個下劃線換成數字。
2. keyCode 為 8 代表 Backspace:刪掉數字並補回一個下劃線。
3. 其他情況一律 return false,直接擋掉。

前兩支都需要用到 setTimeout,因為在 keydown 階段字符尚未真正寫入,延遲到下一個事件迴圈再處理就能讀到更新後的值。

游標歸位:resetCursor()

整個控件裡呼叫次數最多的就是這個函數,負責把游標移到下一個該填的位置:

// 設定游標到正確的位置
function resetCursor(elem) {
  var value = elem.value;
  var index = value.length;
  // 使用者若選取部分文字刪除,長度會跑掉,此時重置為初始格式
  if (elem.value.length !== dateStr.length) {
    elem.value = dateStr;
  }
  // 把游標放到第一個下劃線前面,找不到就放末尾
  var temp = value.search(/_/);
  index = temp > -1 ? temp : index;
  setCursor(elem, index);
}

完整程式碼

$(function(){
  var inputs = $(".hhm-dateInputer");
  var dateStr = "____-__-__";

  inputs.each(function(index, elem){
    var input = $(this);

    input.on("keydown", function(event){
      var that = this;          // 當前觸發事件的輸入框
      var key = event.keyCode;
      var cursorIndex = getCursor(that);

      // 輸入數字
      if(key >= 48 && key <= 57){
        // 游標在末尾,或下一個字符是 "-",阻止輸入
        if(cursorIndex == dateStr.length || that.value.charAt(cursorIndex) === "-") return false;
        // 字串中已無下劃線,阻止輸入
        if(that.value.search(/_/) === -1) return false;

        var fron = that.value.substring(0, cursorIndex); // 游標前的文字
        var reg = /(d)_/;
        setTimeout(function(){           // 此時字符已輸入完成
          var end = that.value.substring(cursorIndex, that.value.length);
          // 去掉新插入數字後面的下劃線
          that.value = fron + end.replace(reg, "$1");
          resetCursor(that);
        }, 1);
        return true;

      // Backspace 刪除鍵
      } else if( key == 8){
        // 游標在最前面時不能刪,但全選後的刪除要放行
        if(!cursorIndex && !getSelection(that).length) return false;

        // 刪除位置遇到連字號的處理
        if(that.value.charAt(cursorIndex - 1) == "-"){
          var ar = that.value.split("");
          ar.splice(cursorIndex - 2, 1, "_");
          that.value = ar.join("");
          resetCursor(that);
          return false;
        }
        setTimeout(function(){
          // 值為空時重置
          if(that.value === "") {
            that.value = "____-__-__";
            resetCursor(that);
          }
          // 刪除的位置補回下劃線
          var cursor = getCursor(that);
          var ar = that.value.split("");
          ar.splice(cursor, 0, "_");
          that.value = ar.join("");
          resetCursor(that);
        }, 1);
        return true;
      }
      return false;
    });

    input.on("focus", function(){
      if(!this.value){
        this.value = "____-__-__";
      }
      resetCursor(this);
    });

    input.on("blur", function(){
      if(this.value === "____-__-__"){
        this.value = "";
      }
    });
  });

  function resetCursor(elem){
    var value = elem.value;
    var index = value.length;
    if(elem.value.length !== dateStr.length){
      elem.value = dateStr;
    }
    var temp = value.search(/_/);
    index = temp > -1 ? temp : index;
    setCursor(elem, index);
  }
});

幾個關鍵技巧

用下劃線當佔位符。「____-__-__」不只是視覺提示,它同時是程式的狀態記錄——search(/_/) 告訴我們還有幾格沒填,游標該去哪裡,都能從這個字串推出來。

遇到連字號的跳躍處理。刪除時若游標前一個字符是「-」,直接把它替換成下劃線並 return false,讓使用者不會誤刪掉分隔符號。

setTimeout(fn, 1) 的時機。這是整個控件能運作的關鍵——延遲到字符真正寫入輸入框之後,才去讀取新值並整理格式。

這個控件還有精進空間:目前缺少「透過 JS 呼叫為元素綁定插件」的對外介面,若能在實作中發現任何邊界情況的 bug,也歡迎隨時指正。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved