Skip to content

CheckboxCell 多选框 ^1.0.0 Beta

CheckboxCell 是一个内置的多选框单元格组件,支持单元格级别的全选/半选功能。

基础使用

通过 createCheckboxCell 工厂函数创建 CheckboxCellCheckboxAllCell 组件,分别用于 customCellcustomHeaderCell

loading

使用第三方组件

可以通过 checkboxComponent 传入 UI 库的 Checkbox 组件,以保持项目整体样式统一。

loading

createCheckboxCell 选项

createCheckboxCell 工厂函数接受一个配置对象:

ts
interface createCheckboxCellOptions<T = any> {
    /** 行数据中表示选中状态的字段名,默认 '_isChecked' */
    field?: string;
    /** 自定义 checkbox 组件(如 Element Plus / Ant Design Vue 的 Checkbox) */
    checkboxComponent?: any;
    /** 单元格 checkbox 状态变更回调 */
    onChange?: (checked: boolean, row: T) => void;
    /** 全选 checkbox 状态变更回调 */
    onSelectAll?: (checked: boolean) => void;
}
属性类型默认值说明
fieldstring'_isChecked'行数据中表示选中状态的字段名
checkboxComponentComponent-自定义 checkbox 组件,不传则使用原生 input[type=checkbox]
onChange(checked, row) => void-单元格 checkbox 状态变更回调
onSelectAll(checked) => void-全选 checkbox 状态变更回调

根据 MIT 许可证发布