华炎魔方微页面引擎,内置相关列表组件 RecordDetailRelatedList,借助amis渲染器,可以帮助开发人员快速生成一个功能完善的相关列表视图组件。
这是一个华炎魔方相关列表视图组件,一般用于在记录详情界面显示相关子表列表,它把对象相关表记录显示为表格,同时包含了对象记录的增删改查以及其他操作按钮功能。
最基本的用法是配置组件的“父级对象”、“父级记录”及“相关列表对象”属性,就可以显示出某条对象记录的相关列表界面效果。
如下所示我们配置相关列表的“父级对象”属性为当前对象,“父级记录”属性为当前记录,相关列表属性配置为“联系人”:
{
type: 'page',
title: '列表视图',
body: {
"type": "steedos-object-related-listview",
"objectApiName": "${objectName}",
"recordId": "${recordId}",
"relatedObjectApiName": "contacts"
},
}
如果我们按照教程 Amis微页面 - 记录页面 新建一个指向业务伙伴 accounts 对象的微页面,并拖动一个相关列表组件到画布,可以看到该组件生成了类似上面的amis Schema配置。
发布后,我们就可以在业务伙伴对象的记录详细页面看到当前记录关联的联系人子表列表界面效果。
objectApiName属性可以被配置为像space_users
或accounts
这种固定值,也可以配置为变量,而变量objectName
在“记录页面”、“列表页面”以及“表单”类型的微页面中存储了当前对象Api名称。
recordId属性类似的可以配置为某个具体的记录id值,但是一般我们会配置为变量,比如在“记录页面”或“表单”类型的微页面中配置为当前记录Id值。
该组件支持下面的配置。
属性名 | 类型 | 默认值 | 说明 |
---|---|---|---|
objectApiName | string | 无 | 父级对象api名称 |
recordId | string | 无 | 父级记录ID值 |
relatedObjectApiName | string | 无 | 相关列表对象api名称 |
columns | [object] | 无 | 要显示的对象字段 |
filters | [string] | 无 | 过滤条件 |
sortField | string | 无 | 排序字段 |
sortOrder | string | 无 | 排序顺序 |
top | number | 10 | 要显示的记录数量 |
perPage | number | 20 | 设置一页显示多少条数据 |
属性名 | 类型 | 默认值 | 说明 |
---|---|---|---|
field | string | 无 | 字段api名称 |