mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-20 12:28:10 +08:00
882cec62d6
* docs: Add components overview page * fix detail * remove ContributorsList form overview page * fix components url * improve code style * remove extra file * fix detail * fix lint * fix lint * docs: Finish components overview page * fix lint * docs: Update cover * fix lint * update cover * update menu * improve overview page * refactor code * fix order * update title * add components count * fix overview page ssr bug * move less file * update title margin Co-authored-by: arvinxx <arvinx@foxmail.com>
73 lines
3.3 KiB
Markdown
73 lines
3.3 KiB
Markdown
---
|
|
category: Components
|
|
type: 数据展示
|
|
title: List
|
|
subtitle: 列表
|
|
cols: 1
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/5FrZKStG_/List.svg
|
|
---
|
|
|
|
通用列表。
|
|
|
|
## 何时使用
|
|
|
|
最基础的列表展示，可承载文字、列表、图片、段落，常用于后台数据展示页面。
|
|
|
|
## API
|
|
|
|
### List
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| --- | --- | --- | --- | --- |
|
|
| bordered | 是否展示边框 | boolean | false | |
|
|
| footer | 列表底部 | string\|ReactNode | - | |
|
|
| grid | 列表栅格配置 | [object](#List-grid-props) | - | |
|
|
| header | 列表头部 | string\|ReactNode | - | |
|
|
| itemLayout | 设置 `List.Item` 布局, 设置成 `vertical` 则竖直样式显示, 默认横排 | string | - | |
|
|
| loading | 当卡片内容还在加载中时，可以用 `loading` 展示一个占位 | boolean\|[object](/components/spin/#API) ([更多](https://github.com/ant-design/ant-design/issues/8659)) | false | |
|
|
| loadMore | 加载更多 | string\|ReactNode | - | |
|
|
| locale | 默认文案设置，目前包括空数据文案 | object | emptyText: '暂无数据' | |
|
|
| pagination | 对应的 `pagination` 配置, 设置 `false` 不显示 | boolean\|object | false | |
|
|
| size | list 的尺寸 | `default` \| `large` \| `small` | `default` | |
|
|
| split | 是否展示分割线 | boolean | true | |
|
|
| dataSource | 列表数据源 | any[] | - | |
|
|
| renderItem | 当使用 dataSource 时，可以用 `renderItem` 自定义渲染列表项 | `item => ReactNode` | - | |
|
|
|
|
### pagination
|
|
|
|
分页的配置项。
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| -------- | ------------------ | --------------------------- | -------- |
|
|
| position | 指定分页显示的位置 | `top` \| `bottom` \| `both` | `bottom` |
|
|
|
|
更多配置项，请查看 [`Pagination`](/components/pagination/)。
|
|
|
|
### List grid props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| ------ | -------------------- | ------ | ------ | ---- |
|
|
| column | 列数 | number | - | |
|
|
| gutter | 栅格间隔 | number | 0 | |
|
|
| xs | `<576px` 展示的列数 | number | - | |
|
|
| sm | `≥576px` 展示的列数 | number | - | |
|
|
| md | `≥768px` 展示的列数 | number | - | |
|
|
| lg | `≥992px` 展示的列数 | number | - | |
|
|
| xl | `≥1200px` 展示的列数 | number | - | |
|
|
| xxl | `≥1600px` 展示的列数 | number | - | |
|
|
|
|
### List.Item
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| --- | --- | --- | --- | --- |
|
|
| actions | 列表操作组，根据 `itemLayout` 的不同, 位置在卡片底部或者最右侧 | Array<ReactNode> | - | |
|
|
| extra | 额外内容, 通常用在 `itemLayout` 为 `vertical` 的情况下, 展示右侧内容; `horizontal` 展示在列表元素最右侧 | string\|ReactNode | - | |
|
|
|
|
### List.Item.Meta
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| ----------- | ------------------ | ----------------- | ------ | ---- |
|
|
| avatar | 列表元素的图标 | ReactNode | - | |
|
|
| description | 列表元素的描述内容 | string\|ReactNode | - | |
|
|
| title | 列表元素的标题 | string\|ReactNode | - | |
|