List列表
List
列表
最基础的列表展示,可承载文字、列表、图片、段落。
| 使用import{ List }from"antd"; | 
| 文档编辑此页 | 
最基础的列表展示,可承载文字、列表、图片、段落,常用于后台数据展示页面。



通用属性参考:通用属性
另外我们封装了 ProList,在 antd List 之上扩展了更多便捷易用的功能,比如多选,展开等功能,使用体验贴近 Table,欢迎尝试使用。
| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|---|---|---|---|---|
| bordered | 是否展示边框 | boolean | false | |
| dataSource | 列表数据源 | any[] | - | |
| footer | 列表底部 | ReactNode | - | |
| grid | 列表栅格配置 | object | - | |
| header | 列表头部 | ReactNode | - | |
| itemLayout | 设置 List.Item布局,设置成vertical则竖直样式显示,默认横排 | string | - | |
| loading | 当卡片内容还在加载中时,可以用 loading展示一个占位 | boolean | object (更多) | false | |
| loadMore | 加载更多 | ReactNode | - | |
| locale | 默认文案设置,目前包括空数据文案 | object | {emptyText: 暂无数据} | |
| pagination | 对应的 pagination配置,设置 false 不显示 | boolean | object | false | |
| renderItem | 当使用 dataSource 时,可以用 renderItem自定义渲染列表项 | (item) => ReactNode | - | |
| rowKey | 当 renderItem自定义渲染列表项有效时,自定义每一行的key的获取方式 | keyofT | (item: T) =>React.Key | "key" | |
| size | list 的尺寸 | default|large|small | default | |
| split | 是否展示分割线 | boolean | true | 
分页的配置项。
| 参数 | 说明 | 类型 | 默认值 | 
|---|---|---|---|
| position | 指定分页显示的位置 | top|bottom|both | bottom | 
| align | 指定分页对齐的位置 | start|center|end | end | 
更多配置项,请查看 Pagination。
| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|---|---|---|---|---|
| column | 列数 | number | - | |
| gutter | 栅格间隔 | number | 0 | |
| xs | <576px展示的列数 | number | - | |
| sm | ≥576px展示的列数 | number | - | |
| md | ≥768px展示的列数 | number | - | |
| lg | ≥992px展示的列数 | number | - | |
| xl | ≥1200px展示的列数 | number | - | |
| xxl | ≥1600px展示的列数 | number | - | 
| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|---|---|---|---|---|
| actions | 列表操作组,根据 itemLayout的不同,位置在卡片底部或者最右侧 | Array<ReactNode> | - | |
| classNames | 语义化结构 className | Record<actions | extra, string> | - | 5.18.0 | 
| extra | 额外内容,通常用在 itemLayout为vertical的情况下,展示右侧内容;horizontal展示在列表元素最右侧 | ReactNode | - | |
| styles | 语义化结构 style | Record<actions | extra, CSSProperties> | - | 5.18.0 | 
| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|---|---|---|---|---|
| avatar | 列表元素的图标 | ReactNode | - | |
| description | 列表元素的描述内容 | ReactNode | - | |
| title | 列表元素的标题 | ReactNode | - | 

| Token 名称 | 描述 | 类型 | 默认值 | 
|---|---|---|---|
| avatarMarginRight | 头像右间距 | undefined | MarginRight<string | number> | 16 | 
| contentWidth | 内容宽度 | string | number | 220 | 
| descriptionFontSize | 描述文字大小 | number | 14 | 
| emptyTextPadding | 空文本内边距 | undefined | Padding<string | number> | 16 | 
| footerBg | 底部区域背景色 | string | transparent | 
| headerBg | 头部区域背景色 | string | transparent | 
| itemPadding | 列表项内间距 | string | 12px 0 | 
| itemPaddingLG | 大号列表项内间距 | string | 16px 24px | 
| itemPaddingSM | 小号列表项内间距 | string | 8px 16px | 
| metaMarginBottom | Meta 下间距 | undefined | MarginBottom<string | number> | 16 | 
| titleMarginBottom | 标题下间距 | undefined | MarginBottom<string | number> | 12 |