萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

jQuery 自定義 Checkbox/Radio 美化插件:替換原生樣式、支持數據屬性配置

插件效果預覽

將原生 <input type="checkbox"> 轉換為可完全 CSS 控制的 <span> 結構,支持:

  • 自定義 ON/OFF 文本(支持 data-on/data-off 屬性)
  • 同步原生 checkbox 狀態(表單提交無感知)
  • 鏈式調用、多實例隔離
  • 輕量無依賴(除 jQuery)

自定義Checkbox效果圖

完整插件代碼

(function($) {
  $.fn.tzCheckbox = function(options) {
    // 默認配置
    var settings = $.extend({
      labels: ['ON', 'OFF'] // [開啟文本, 關閉文本]
    }, options);
    
    return this.each(function() {
      var $original = $(this); // 原生 checkbox
      var labels = settings.labels;
      
      // 優先讀取 HTML5 data 屬性
      if ($original.data('on')) {
        labels[0] = $original.data('on');
        labels[1] = $original.data('off') || labels[1];
      }
      
      // 構建新結構
      var $checkBox = $('', {
        className: 'tzCheckBox ' + (this.checked ? 'checked' : ''),
        html: '' + labels[this.checked ? 0 : 1] + '' +
              '' // 裝飾性部件(如滑塊背景)
      });
      
      // 插入並隱藏原生
      $checkBox.insertAfter($original.hide());
      
      // 點擊新元素觸發狀態切換
      $checkBox.click(function() {
        $checkBox.toggleClass('checked');
        var isChecked = $checkBox.hasClass('checked');
        
        // 同步原生 checkbox(關鍵:表單提交時自動攜帶正確值)
        $original.prop('checked', isChecked).trigger('change');
        
        // 更新顯示文本
        $checkBox.find('.tzCBContent').text(labels[isChecked ? 0 : 1]);
      });
      
      // 監聽原生 change 事件(如 JS 代碼觸發 $original.prop('checked', true) 時同步 UI)
      $original.on('change', function() {
        $checkBox.click(); // 觸發同樣邏輯
      });
    });
  };
})(jQuery);

CSS 樣式參考

.tzCheckBox {
  display: inline-block;
  position: relative;
  width: 60px;
  height: 28px;
  border-radius: 14px;
  background: #ddd;
  cursor: pointer;
  transition: background 0.2s;
  user-select: none;
}
.tzCheckBox.checked { background: #007bff; }
.tzCheckBox .tzCBContent {
  position: absolute;
  top: 50%; left: 50%;
  transform: translate(-50%, -50%);
  font-size: 12px; font-weight: bold; color: #fff;
  white-space: nowrap;
}
.tzCheckBox .tzCBPart {
  position: absolute;
  top: 2px; left: 2px;
  width: 24px; height: 24px;
  border-radius: 50%;
  background: #fff;
  box-shadow: 0 1px 3px rgba(0,0,0,0.3);
  transition: left 0.2s;
}
.tzCheckBox.checked .tzCBPart { left: 34px; } /* 60-24-2=34 */

/* 隱藏原生但保留可訪問性 */
.tzCheckBox + input[type="checkbox"] { position: absolute; opacity: 0; pointer-events: none; }

使用示例

<!-- 基礎用法 -->
<input type="checkbox" id="agree" class="custom-check">
<label for="agree">同意條款</label>

<!-- 自定義文本 -->
<input type="checkbox" id="notify" data-on="啟用" data-off="關閉">

<script>
$(function() {
  $('.custom-check').tzCheckbox(); // 使用默認 ON/OFF
  $('#notify').tzCheckbox(); // 自動讀取 data-on/off
});
</script>

Radio 按鈕擴展版

$.fn.tzRadio = function(options) {
  var settings = $.extend({ label: '' }, options);
  return this.each(function() {
    var $original = $(this);
    var name = $original.attr('name'); // 必須有 name 分組
    
    var $radio = $('', {
      className: 'tzRadio' + ($original.is(':checked') ? ' checked' : ''),
      html: '' + (settings.label || '') + ''
    }).insertAfter($original.hide());
    
    $radio.click(function() {
      // 同組只能選一:先取消同組其他
      $('input[name="' + name + '"]').not($original).each(function() {
        $(this).prop('checked', false).next('.tzRadio').removeClass('checked');
      });
      $original.prop('checked', true).trigger('change');
      $radio.addClass('checked');
    });
    
    $original.on('change', function() {
      $radio.click();
    });
  });
};

無障礙增強

為符合 WCAG,需補充:

  1. role="checkbox" + aria-checked="true/false"
  2. tabindex="0" 支持鍵盤聚焦
  3. keydown 監聽 Space/Enter 切換
// 在插件 click 綁定前添加
$checkBox.attr({ 'role': 'checkbox', 'aria-checked': this.checked, 'tabindex': 0 })
  .on('keydown', function(e) {
    if (e.key === ' ' || e.key === 'Enter') {
      e.preventDefault();
      $(this).click();
    }
  });
// 狀態更新時同步 aria
$checkBox.attr('aria-checked', isChecked);

總結

本插件通過隱藏原生控件 + 構建語義化替代結構 + 雙向同步狀態實現樣式完全可控。核心設計點:

  • 保留原生 checkbox 確保表單提交正常
  • data-* 屬性實現零 JS 配置
  • 事件代理機制同步外部 JS 修改
  • 輕量級(<1KB gzipped),無第三方依賴

同理可擴展實現 Radio、Switch、Select 等表單控件美化,構建統一設計語言的表單組件庫。

copyright © 萬盛學電腦網 all rights reserved