React 多选列

通过列类型 checkbox 添加行多选列，支持单选、全选及清除选中。

使用的 API

type Column = {
  key: string;  // 列标识(必填)
  title: string;  // 列标题(必填)
  width: number;  // 列宽(必填)
  type: 'checkbox';  // 特殊列类型：多选列
  align: 'left' | 'center' | 'right';  // 列的水平对齐（应用于表头、表身、表尾）
}

type Options = {
  list: T[];  // 数据列表
  itemKey: string;  // 行唯一标识字段名
  estimatedSize: number;  // 行预估高度(px)
  buffer: number;  // 缓冲区行数
  border: boolean;  // 是否显示边框
}

示例

微应用尚未挂载。

源码

点击查看源码

import React from 'react';
import { VirtTableReact, type ReactTableColumn, type VirtTableRef } from '@virt-table/react';
import { faker } from '@faker-js/faker';

const DATA_COL = 8;
const ROW_COUNT = 200;

const columns: ReactTableColumn[] = [
  { key: '__ck', title: '', width: 50, type: 'checkbox' as const, align: 'center' as const },
  ...Array.from({ length: DATA_COL }, (_, i) => ({
    key: `extra_${i}`,
    title: `列 ${i}`,
    width: 150,
  })),
];

const list = Array.from({ length: ROW_COUNT }, (_, i) => {
  const row: Record<string, unknown> = { id: i };
  for (let c = 0; c < DATA_COL; c++) {
    row[`extra_${c}`] = `${i}-${c}-${faker.lorem.word()}`;
  }
  return row;
});

export default function CheckboxTable() {
  const tableRef = React.useRef<VirtTableRef>(null);
  const [status, setStatus] = React.useState('多选 + 8 列数据');
  return (
    <div className="demo-wrapper">
      <h3 className="demo-title">React 多选行</h3>
      <div className="virt-table-controls">
        <button
          type="button"
          onClick={() => {
            tableRef.current?.clearCheckedRows();
            setStatus('已清空多选');
          }}
        >
          清空多选
        </button>
      </div>
      <div className="status-text">{status}</div>
      <div style={{ width: 800, height: 600 }} className="demo-container">
        <VirtTableReact
          ref={tableRef}
          columns={columns}
          options={{
            list,
            itemKey: 'id',
            estimatedSize: 40,
            buffer: 4,
            border: true,
            onCheckChange: (checked, row) => {
              setStatus(`onCheckChange: ${checked} id=${(row as { id: number }).id}`);
            },
            onCheckAll: (checked) => {
              setStatus(`onCheckAll: ${checked}`);
            },
          }}
        />
      </div>
    </div>
  );
}