跳到主要内容

List

容器属性

所有组件配置的第一层均支持容器属性

组件属性 componentsProps

NameTypeDefault是否支持 Variable PatternDescription
classNamestring✔️组件的 className
styleobject组件的 style
itemFieldobject@deprecated, 使用 fields 替代, List 里每个元素的 json schema,支持使用所有 form 的元素
direction'row' | 'column'@deprecated,使用 style.flexDirection 替代。
wrapboolfalse@deprecated,使用 style.flexWrap 替代。
gapnumber@deprecated,使用 style.gap 替代。
emptybool | objectfalse当无数据的时候显示的占位符,antd 的 Empty 的属性
itemPropsobject传给每个子元素顶层 div 的属性
LoadingPropsLoadingProps传给 Loading 组件的属性
dataSource{ token: string, pbcToken: string, listUrl: string }数据源
dataUrlConditionalListOrSinglePropertyPropType(string)通过 dataUrl 获取数据。
dataFiltersConditionalListPropertyPropType(DataFilters)✔️请求数据源隐藏的固定 filter 条件,无法通过界面进行改变
sortModelArray<SortModel>数据的排序方式
dataResponseKeyPathstring'results'取 response data 里的某一个子数据来作为结果。
transformDataResponsestring转换取到的数据,使用 eval 表达式,this 指向获取到的数据。
translateDataResponsebooltrue是否需要翻译请求结果
debounceTimenumber200请求数据的 debounce time,会触发 leading。
defaultValueobject数据源的默认数据,会和 api 请求到的数据进行 merge。如果 api 请求返回的是数组,则和数组的每一项进行 merge。如果 api 请求返回的是个对象,则和此对象进行 merge。
httpMethod'get' | 'post''get'数据请求的http方法。
selectColIdArray<string>加载的数据字段,不配置则加载所有字段。
lazyLoadingboolfalse是否开启懒加载
cacheBlockSizenumber30懒加载每次请求的数据量

所有其余 componentsProps 将会被传给组件根元素(div)。

SortModel

NameTypeDefaultDescription
colIdstring排序字段 id
sort'asc' | 'desc''asc'生序或者降序排序
sortType'text' | 'number' | 'date''text'值按照什么类型进行排序

LoadingProps

NameTypeDefaultDescription
sizenumber20loading 元素大小,默认 20px
centeredbooltrue是否居中显示
overlayboolfalse是否显示半透明遮罩层
delayedboolfalse是否延迟显示
delayTimenumber800延迟时间(ms)

JS API

通过 formApi.getFieldApi() 获取的接口如下:

NameTypeDescription
nodeHTML Element组件的根 DOM 元素
getData() => any获取所有数据
refresh() => void刷新数据