Skip to content

API 参考

EditableTable Props

属性类型默认值说明
rowKeykeyof T & string行唯一标识字段名(必填
columnsEditableColumn<T>[]列定义(必填
dataSourceT[]数据源(必填
onChange(data: T[]) => void数据变化回调
editableMode'all' | 'row''all'编辑模式
onSubmit(data: T[]) => void提交回调,校验通过后触发
validateTrigger'submit' | 'change''submit'校验触发时机
scrollYnumber虚拟滚动容器高度(px),传入时启用虚拟滚动
emptyTextstring'暂无数据'空数据提示文案
classNamestring容器类名
styleCSSProperties容器样式

EditableColumn

属性类型默认值说明
titleReactNode列标题(必填
dataIndexkeyof T & string数据字段名(必填
widthnumber | string150列宽
fixed'left' | 'right'列固定方向
editablebooleantrue是否可编辑
editRender(props: EditRenderProps<T>) => ReactNode自定义编辑态渲染
rulesRule[]校验规则
onFieldChange(value: any, row: T) => Partial<T> | undefined | Promise<Partial<T> | undefined>字段联动回调,支持异步
render(value: any, row: T, rowIndex: number) => ReactNode自定义只读态渲染

EditRenderProps

属性类型说明
valueany当前单元格的值
onChange(value: any) => void值变化回调
rowT当前行完整数据
rowIndexnumber行索引
errorstring | undefined校验错误信息

Rule

属性类型说明
requiredboolean是否必填
validator(value: any, row: T) => boolean | string自定义校验函数
messagestring校验失败错误信息

validator 返回值说明:

  • true:校验通过
  • false:校验失败,使用 message 作为错误信息
  • string:校验失败,使用返回的字符串作为错误信息

EditableTableInstance (ref)

方法参数说明
addRowdefaults?: Partial<T>在末尾新增一行
insertRowrowIndex: number, defaults?: Partial<T>在指定位置插入一行
removeRowrowIndex: number删除指定行
updateRowrowIndex: number, updates: Partial<T>部分更新指定行数据
moveUprowIndex: number上移指定行
moveDownrowIndex: number下移指定行
getData获取当前数据
validateAll全量校验,返回 { isValid: boolean; errors: Record<string, string> }

基于 MIT 许可发布