Renewals
CLI 将组件源(及其内部依赖项)复制到您的项目中并安装任何所需的 npm 包。
npx boardui@latest add data-grid使用共享 UI 包或自定义导入别名? 配置您的安装路径 在运行 CLI 之前。复制粘贴示例使用默认导入。
列与编辑
传入有类型的 columns,你的 data,以及唯一且稳定的 getRowId。提供 onDataChange 以启用编辑。文本、数字和选择编辑器复用 BoardUI 输入框及选择控件。使用以下属性设置范围 min 和 max,或使用以下方式拒绝值 validate.
使用 format 用于单元格显示,以及 formatSummary 用于显示总和、平均值或计数的页脚。设置 editable= 用于各个列。格式设置只改变显示方式;编辑、复制和导出均使用原始值。
const columns: DataGridColumn<Account>[] = [ { key: "account", header: "Account", width: 220, validate: (value) => String(value).trim() ? undefined : "Account cannot be empty." }, { key: "stage", header: "Stage", type: "select", options: ["Discovery", "Proposal", "Closed won"] }, { key: "seats", header: "Seats", type: "number", min: 0, summary: "sum" }, { key: "arr", header: "ARR", type: "number", min: 0, editable: false, summary: "sum", formatSummary: (value) => `$${value.toLocaleString("en-US")}` },];
// Omit onDataChange to make every cell read-only.<DataGrid aria-label="Accounts" data={data} columns={columns} getRowId={getRowId} />搜索、筛选与导出
搜索所有列,点击标题可在升序、降序和原始顺序间切换,也可按精确值筛选。选择型列会自动显示在筛选菜单中;添加 filterable 到其他列。隐藏列、拖动分隔线调整列宽,并在舒适行与紧凑行之间切换。
第一个可见列固定在行号旁边。在窄屏上,它会随其他列滚动,以确保每个单元格都可访问。行复选框独立于单元格范围选择记录;表头复选框可切换全部筛选后的行。选中行后,工具栏显示数量以及删除、复制和导出操作。复制使用制表符分隔的值,导出下载 CSV;两者均使用可见列和选中的可见记录。删除需要 onDataChange 且可以撤销。清除选择即可返回搜索和视图控件。汇总始终反映筛选后的记录。
键盘与剪贴板
按 Tab 进入网格,使用箭头键在单元格间移动。按住 Shift 扩展范围,或使用鼠标跨单元格拖动。Home 和 End 在行内移动;加上 ⌘ 或 Ctrl 可跳至第一条或最后一条记录。Page Up 和 Page Down 每次移动一个视口。⌘/Ctrl+A 选择所有单元格。
选中带选项的单元格即可显示下拉控件,然后点击箭头选择值。双击、Enter 或 F2 可打开单元格编辑器。Enter 保存并向下移动;Shift+Enter 向上移动。Tab 保存并移至下一个单元格。Escape 取消。使用常用键盘快捷键复制范围并粘贴制表符分隔的电子表格数据。无效值会使整次粘贴被拒绝。撤销和重做适用于单元格编辑、粘贴及行删除,网格挂载期间最多保留 100 次操作。
为每个网格提供 aria-label。将从右向左的区域包裹在 DirectionProvider;固定列、菜单和水平箭头键均遵循阅读方向。
小视口中的 10,000 行
上方预览包含 10,000 条实际记录。固定高度虚拟化仅挂载视口内及其周围的行。表头和汇总保留在滚动区域之外;滚动时顶部边缘会逐渐模糊。设置 height 可更改视口高度。
搜索、排序、筛选和汇总均在浏览器中基于传入的数据执行。记录移动时,单元格选择和编辑会跟随稳定的行 ID。请在以下位置持久化更改 onDataChange 处理函数中。用新的 React key 在切换到不同数据集时重新挂载,以重置视图状态和编辑历史。
从右向左与只读
使用 DirectionProvider 以设置阅读方向。此只读示例将首列固定在右侧,并镜像水平键盘导航。列标签和记录值可以使用任何语言。