跳到主要内容

useRecords

获得表格中一个指定视图下面所有的 Records。 当记录的值、视图配置、字段配置发生变化的时候,会触发重新渲染。 获取所有的 records 可能造计算量急剧上升而产生卡顿,请谨慎使用并做好充分测试。

参数

NameTypeDescription
viewIdstring | undefined视图 ID, 传入 undefined 则返回空数组
query?IRecordQuery查询配置参数

返回值

Record[]

示例

import { useRecords, useActiveViewId } from '@apitable/widget-sdk';

// 展示记录主键
function RecordsTitle() {
const viewId = useActiveViewId();
const records = useRecords(viewId);
return (<div>
{records.map(record => <p>{record.title}</p>)}
</div>);
}

useRecords(datasheet, viewId, query?): Record[]

支持加载对应表格数据 Records

参数

NameTypeDescription
datasheetDatasheet | undefinedDatasheet 实例,通过 useDatasheet 获取
viewIdstring | undefined视图 ID, 传入 undefined 则返回空数组
query?IRecordQuery查询配置参数

返回值

Record[]

示例

import { useRecords, useViewsMeta, useDatasheet } from '@apitable/widget-sdk';

// 展示对应 datasheetId(dstXXXXXXXX) 表的记录主键
function RecordsTitle() {
const datasheet = useDatasheet('dstXXXXXXXX');
const viewsMeta = useViewsMeta(datasheet);
const records = useRecords(datasheet, viewsMeta[0]?.id);
return (
<div>
{records.map(record => <p>{record.title}</p>)}
</div>
);
}