华炎魔方微页面引擎,内置对象列表组件 ObjectListView,借助amis渲染器,可以帮助开发人员快速生成一个功能完善的列表视图组件。
这是一个基于华炎魔方对象的列表视图组件,它把对象记录显示为表格,同时包含了对象记录的增删改查以及其他操作按钮功能。
最基本的用法是配置组件的“对象”及“视图”属性,就可以显示出指定对象的列表页面。
如下所示我们配置对象列表的“对象”属性为当前对象,“视图”属性为当前对象的“有效人员”视图:
{
type: 'page',
title: '列表视图',
body: {
"type": "steedos-object-listview",
"objectApiName": "${objectName}",
"listName": "all"
},
}
如果我们按照教程 Amis微页面 - 列表页面 新建一个指向人员对象的微页面,并拖动一个对象列表组件到画布,可以看到该组件生成了类似上面的amis Schema配置。
发布后,我们就可以在人员对象的列表页面看到人员列表效果。
objectApiName属性可以被配置为像space_users
或accounts
这种固定值,也可以配置为变量,而变量objectName
在“记录页面”、“列表页面”以及“表单”类型的微页面中存储了当前对象Api名称。
listName属性类似的可以配置为某个固定的列表视图值,也可以配置为某个变量值。
该组件支持下面的配置。
属性名 | 类型 | 默认值 | 说明 |
---|---|---|---|
objectApiName | string | space_users | 关联对象api名称 |
listName | string | 无 | 要显示的对象视图名称 |
perPage | number | 20 | 设置一页显示多少条数据 |
showHeader | boolean | false | 显示表头 |
formFactor | string | 无 | 显示样式:表格/手机 |
className | string | “sm:border sm:shadow sm:rounded sm:border-gray-300 mb-4” | CSS类名 |
当 showHeader 属性被设置为 true
时,请注意:
listName,top,perPage
等属性会被应用到所有视图中。listName
属性值,否则当切换列表视图时将始终会跳转到该属性值指向的视图。listName
属性配置栏,因为此时不允许配置listName
属性值。新建“列表页面”类型的微页面时 showHeader
属性会被默认设置为 true
以允许用户在微页面中对表头部分进行二次开发。