跳到主要内容

EntityTableProps

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:57

EntityTable 的 props。

Properties​

cellClearable?​

optional cellClearable?: (record, field) => boolean;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:75

业务层回调判断单元格是否可清空(返回 false 跳过)。

Parameters​

ParameterType
recordRecord<string, unknown>
fieldstring

Returns​

boolean


cellErrorDetector?​

optional cellErrorDetector?: (record, field) => string | null;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:71

单元格错误检测器(悬停时显示 tooltip)。

Parameters​

ParameterType
recordEntityTableRecord
fieldstring

Returns​

string | null


columns​

columns: ColumnsDefine;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:61

列定义。


emptyState?​

optional emptyState?: ReactNode;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:81

空态插槽(有内容时替代默认空态)。


idField?​

optional idField?: string;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:65

主键字段名,缺省 'id'。


isDarkMode?​

optional isDarkMode?: boolean;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:63

暗色模式;缺省时自动探测(data-theme / prefers-color-scheme)。


loading?​

optional loading?: boolean;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:73

是否显示加载态。


loadingMore?​

optional loadingMore?: boolean;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:79

加载更多中状态(已有数据,底部小 spinner,不拦截滚动)。


loadMore?​

optional loadMore?: () => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:77

触底时加载更多数据的回调。

Returns​

void


nonClearableFields?​

optional nonClearableFields?: ReadonlySet<string>;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:67

不可清空的字段集合(Delete 清空时跳过)。


onBatchUpdated?​

optional onBatchUpdated?: (mutations) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:89

批量变更(剪贴板粘贴 / Delete 清空)。

Parameters​

ParameterType
mutationsBatchChangeItem[]

Returns​

void


onCellChanged?​

optional onCellChanged?: (event) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:83

单元格变更。

Parameters​

ParameterType
eventCellChangeEvent

Returns​

void


onIconClicked?​

optional onIconClicked?: (event) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:87

非删除类图标点击。

Parameters​

ParameterType
event{ name: string; record: EntityTableRecord; }
event.namestring
event.recordEntityTableRecord

Returns​

void


onRowDeleted?​

optional onRowDeleted?: (record) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:85

行删除(delete-action 图标)。

Parameters​

ParameterType
recordEntityTableRecord

Returns​

void


onRowMoved?​

optional onRowMoved?: (move) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:95

单行拖放:被拖行与落点前后邻居(US-028)。

Parameters​

ParameterType
moveRowMoveEvent

Returns​

void


onRowReordered?​

optional onRowReordered?: (orderedIds) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:91

行重排(列头拖拽)。

Parameters​

ParameterType
orderedIdsstring[]

Returns​

void


onScrollNearBottom?​

optional onScrollNearBottom?: () => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:97

触底且未提供 loadMore 时输出。

Returns​

void


onSortClicked?​

optional onSortClicked?: (event) => void;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:99

列头排序点击;业务层接管查询排序,表格不执行客户端排序。

Parameters​

ParameterType
event{ field: unknown; order: unknown; }
event.fieldunknown
event.orderunknown

Returns​

void


records​

records: EntityTableRecord[];

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:59

表格记录。


rowDragEnabled?​

optional rowDragEnabled?: boolean;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:93

是否显示行拖动手柄,缺省 true;运行时切换即时生效(建表需开启 rowSeriesNumber.dragOrder)。


tableOptions?​

optional tableOptions?: Partial<ListTableConstructorOptions>;

Defined in: packages/rxdb-model-react/src/entity-table/entity-table.tsx:69

透传给 VTable 的额外表格选项。