SuperAPI AI 工具集

syncfusion-javascript-list-box

前端与建站

查看项目

更新于 10-16 04:39

技能介绍

用途

Syncfusion ListBox 是 Syncfusion JavaScript UI 控件库中的一个列表选择组件,用于显示一组可供用户选择的项目。该技能文档面向需要在 JavaScript 应用中实现可选择列表的开发者,提供从安装、初始化到高级交互的完整参考。

主要能力

  • 选择模式:支持单选,以及带复选框的多选;多选可配合全选选项。
  • 数据源:支持本地数组、通过 DataManager 绑定的远程数据,以及基于 HTML 元素(如 SELECT、UL)的初始化。
  • 组织方式:支持升序/降序排序,以及按类别分组,并支持 HTML optgroup。
  • 交互:支持同一列表内的拖拽重排,以及通过 scope 绑定实现列表之间的拖拽;提供键盘导航。
  • 无障碍:提供完整的 WAI-ARIA 支持、键盘快捷键和屏幕阅读器兼容。
  • 定制:支持图标、模板、CSS 样式、高度与滚动设置、主题集成和响应式设计。

使用方式

文档按主题组织为多个参考指南,包括:入门(安装、包设置、基本初始化、简单数据绑定、CSS 导入与主题)、数据绑定与字段映射、选择与复选框、拖拽与放置、排序与分组、双列表配置、无障碍与键盘导航、样式与外观,以及操作指南(动态添加项目、启用/禁用项目、编程式选择、启用滚动、显示工具提示、过滤列表数据、处理表单提交)。

快速开始示例使用 @syncfusion/ej2-dropdowns 中的 ListBox,通过 dataSource 绑定数据,用 fields 映射文本与值字段,并在 selectionSettings 中设置 mode: 'Multiple' 与 showCheckbox: true,最后调用 appendTo 挂载到指定元素。

常见模式包括:单选并响应 change 事件(通过 getSelectedItems() 获取选中项);带复选框的多选(可加 showSelectAll,用 selectAll() 编程式选择);列表间拖拽(两个列表均设 allowDragAndDrop: true,用匹配的 scope 关联,并可用工具栏提供移动操作);排序与分组组合展示;以及使用 DataManager 与 Query 处理远程大数据集并做字段映射。

关键属性包括:dataSource(本地或远程数据)、fields(字段映射)、selectionSettings(选择模式与复选框)、sortOrder(排序)、allowDragAndDrop(启用重排)、scope(关联列表以支持拖拽)、height(列表高度)、toolbarSettings(配置移动按钮)。

适用场景

  • 单选下拉菜单
  • 多选选择器(批量操作)
  • 用户自定义项目排序
  • 分类列表展示
  • 双列表项目转移
  • 可搜索列表(配合 TextBox 做客户端或服务端过滤)
  • 无障碍表单字段

限制

资料未提供该组件的收费、价格、平台兼容范围、性能指标或具体效果说明,这些信息暂未提供。