萬盛學電腦網

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

雙向多選列表框完整實作:新增、移動、刪除、全選操作

經典的「雙向選單」UI 模式常用於權限分配、角色配置、商品分類等場景。本文提供原生 JavaScript 完整實作,包含單項/全量移動、重複檢查、保護項目、表單提交序列化等實務功能。

完整 HTML + JavaScript 實作

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>雙向多選列表框 Demo</title>
<style>
  .dual-list { display: flex; gap: 20px; align-items: flex-start; font-family: sans-serif; }
  .list-panel { flex: 1; min-width: 200px; }
  .list-panel h4 { margin: 0 0 10px; padding: 8px; background: #f0f0f0; border-radius: 4px 4px 0 0; }
  .list-panel select { width: 100%; min-height: 200px; border: 1px solid #ddd; border-radius: 0 0 4px 4px; padding: 4px; }
  .controls { display: flex; flex-direction: column; gap: 8px; padding-top: 40px; }
  .controls button { padding: 8px 12px; border: 1px solid #ccc; background: #fff; border-radius: 4px; cursor: pointer; white-space: nowrap; }
  .controls button:hover { background: #f5f5f5; }
  .controls button:disabled { opacity: 0.5; cursor: not-allowed; }
  .selected-count { font-size: 12px; color: #666; margin-top: 8px; }
</style>
</head>
<body>

<div class="dual-list">
  <div class="list-panel">
    <h4>可選項目 (來源)</h4>
    <select id="sourceList" multiple size="10"></select>
    <div class="selected-count" id="sourceCount">共 0 項</div>
  </div>
  
  <div class="controls">
    <button id="btnAddOne" title="新增選中項目">></button>
    <button id="btnAddAll" title="新增全部項目">>|</button>
    <button id="btnRemoveOne" title="移除選中項目"><</button>
    <button id="btnRemoveAll" title="移除全部項目">|<</button>
  </div>
  
  <div class="list-panel">
    <h4>已選項目 (目標)</h4>
    <select id="targetList" multiple size="10"></select>
    <div class="selected-count" id="targetCount">共 0 項</div>
  </div>
</div>

<form id="submitForm" action="/api/save" method="POST" style="margin-top:20px;">
  <input type="hidden" name="selectedValues" id="selectedValues" />
  <button type="submit" class="submit-btn">提交已選項目</button>
</form>

<script>
(function() {
  // === 核心工具函式 ===
  function createOption(text, value) {
    var opt = document.createElement('option');
    opt.text = text;
    opt.value = value;
    return opt;
  }
  
  function getSelectedOptions(selectEl) {
    return Array.from(selectEl.selectedOptions);
  }
  
  function optionExists(selectEl, value) {
    return Array.from(selectEl.options).some(function(opt) { return opt.value === value; });
  }
  
  function updateCounts() {
    document.getElementById('sourceCount').textContent = '共 ' + sourceList.options.length + ' 項';
    document.getElementById('targetCount').textContent = '共 ' + targetList.options.length + ' 項';
  }
  
  function syncHiddenInput() {
    var values = Array.from(targetList.options).map(function(opt) { return opt.value; });
    document.getElementById('selectedValues').value = values.join(',');
  }
  
  function sortOptions(selectEl) {
    var options = Array.from(selectEl.options);
    options.sort(function(a, b) { return a.text.localeCompare(b.text); });
    selectEl.innerHTML = '';
    options.forEach(function(opt) { selectEl.appendChild(opt); });
  }
  
  // === 初始化資料 ===
  var sourceList = document.getElementById('sourceList');
  var targetList = document.getElementById('targetList');
  
  var initialData = [
    { value: 'a', text: '選項 A' },
    { value: 'b', text: '選項 B' },
    { value: 'c', text: '選項 C' },
    { value: 'd', text: '選項 D' },
    { value: 'e', text: '選項 E' }
  ];
  
  // 預設目標已有項目
  var presetTarget = [
    { value: 'a', text: '選項 A' },
    { value: 'd', text: '選項 D' }
  ];
  
  initialData.forEach(function(item) {
    sourceList.appendChild(createOption(item.text, item.value));
  });
  
  presetTarget.forEach(function(item) {
    targetList.appendChild(createOption(item.text, item.value));
  });
  
  // 從來源移除已預設的項目
  presetTarget.forEach(function(item) {
    var idx = Array.from(sourceList.options).findIndex(function(opt) { return opt.value === item.value; });
    if (idx !== -1) sourceList.remove(idx);
  });
  
  updateCounts();
  syncHiddenInput();
  
  // === 事件綁定 ===
  document.getElementById('btnAddOne').addEventListener('click', function() {
    getSelectedOptions(sourceList).forEach(function(opt) {
      if (!optionExists(targetList, opt.value)) {
        targetList.appendChild(createOption(opt.text, opt.value));
      }
    });
    sortOptions(targetList);
    updateCounts();
    syncHiddenInput();
  });
  
  document.getElementById('btnAddAll').addEventListener('click', function() {
    Array.from(sourceList.options).forEach(function(opt) {
      if (!optionExists(targetList, opt.value)) {
        targetList.appendChild(createOption(opt.text, opt.value));
      }
    });
    sortOptions(targetList);
    updateCounts();
    syncHiddenInput();
  });
  
  document.getElementById('btnRemoveOne').addEventListener('click', function() {
    getSelectedOptions(targetList).forEach(function(opt) {
      // 保護機制:value 為 'a' 的項目不可移除
      if (opt.value !== 'a') {
        sourceList.appendChild(createOption(opt.text, opt.value));
        opt.remove();
      }
    });
    sortOptions(sourceList);
    updateCounts();
    syncHiddenInput();
  });
  
  document.getElementById('btnRemoveAll').addEventListener('click', function() {
    Array.from(targetList.options).forEach(function(opt) {
      if (opt.value !== 'a') { // 保護項目
        sourceList.appendChild(createOption(opt.text, opt.value));
        opt.remove();
      }
    });
    sortOptions(sourceList);
    updateCounts();
    syncHiddenInput();
  });
  
  // 雙擊快速移動
  sourceList.addEventListener('dblclick', function() {
    document.getElementById('btnAddOne').click();
  });
  targetList.addEventListener('dblclick', function() {
    document.getElementById('btnRemoveOne').click();
  });
  
  // 表單提交前驗證
  document.getElementById('submitForm').addEventListener('submit', function(e) {
    if (targetList.options.length === 0) {
      e.preventDefault();
      alert('請至少選擇一個目標項目');
    }
  });
})();
</script>
</body>
</html>

核心功能模組解析

1. 重複值檢查機制

function optionExists(selectEl, value) {
  return Array.from(selectEl.options).some(function(opt) { 
    return opt.value === value; 
  });
}

使用 Array.some() 短路求值,效能優於傳統迴圈,確保目標列表無重複值。

2. 保護項目機制

if (opt.value !== 'a') { // 核心業務邏輯:特定值不可移除
  sourceList.appendChild(createOption(opt.text, opt.value));
  opt.remove();
}

適用於「預設必選項目」、「系統保留角色」等業務場景。

3. 隱藏域同步提交

function syncHiddenInput() {
  var values = Array.from(targetList.options).map(function(opt) { return opt.value; });
  document.getElementById('selectedValues').value = values.join(',');
}

表單提交時自動序列化為逗號分隔字串,後端可直接 split(',') 處理。

進階擴充功能

搜尋過濾 (大量資料必備)

<input type="text" id="sourceSearch" placeholder="搜尋來源..." class="search-box" />
<input type="text" id="targetSearch" placeholder="搜尋目標..." class="search-box" />

$('#sourceSearch, #targetSearch').on('input', function() {
  var $this = $(this);
  var targetList = $this.attr('id') === 'sourceSearch' ? sourceList : targetList;
  var keyword = $this.val().toLowerCase();
  
  Array.from(targetList.options).forEach(function(opt) {
    var match = opt.text.toLowerCase().indexOf(keyword) !== -1;
    opt.style.display = match ? '' : 'none';
    opt.hidden = !match; // 配合 CSS: option[hidden] { display: none; }
  });
});

拖曳排序 (HTML5 Drag & Drop)

targetList.addEventListener('dragstart', function(e) {
  if (e.target.tagName === 'OPTION') {
    e.target.classList.add('dragging');
    e.dataTransfer.effectAllowed = 'move';
  }
});

targetList.addEventListener('dragover', function(e) {
  e.preventDefault(); // 允許放置
  var dragging = targetList.querySelector('.dragging');
  var after = getDragAfterElement(targetList, e.clientY);
  if (after) {
    targetList.insertBefore(dragging, after);
  } else {
    targetList.appendChild(dragging);
  }
});

function getDragAfterElement(container, y) {
  return Array.from(container.querySelectorAll('option:not(.dragging)')).reduce(function(closest, child) {
    var box = child.getBoundingClientRect();
    var offset = y - box.top - box.height / 2;
    if (offset < 0 && offset > closest.offset) {
      return { offset: offset, element: child };
    }
    return closest;
  }, { offset: Number.NEGATIVE_INFINITY }).element;
}

伺服器端處理範例

// ASP.NET Core / C#
[HttpPost]
public IActionResult Save(string selectedValues) {
  if (string.IsNullOrEmpty(selectedValues)) return BadRequest("無選項");
  
  var values = selectedValues.Split(',', StringSplitOptions.RemoveEmptyEntries);
  // 處理業務邏輯...
  return Ok(new { count = values.Length, values });
}

// PHP
$selected = explode(',', $_POST['selectedValues'] ?? '');
foreach ($selected as $val) {
  // 處理...
}

這套雙向選單元件功能完整、擴充性強,可直接整合至任何後台管理系統,支援鍵盤操作、搜尋過濾、拖曳排序等現代 UX 需求。

copyright © 萬盛學電腦網 all rights reserved