Skip to content

Commit 278468f

Browse files
committed
refactor: table doc
1 parent 448a433 commit 278468f

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

src/components/table/README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Table 重封装组件说明
183183
// 调用 refresh() 重新加载列表数据
184184
// 这里 setTimeout 模拟发起请求的网络延迟..
185185
setTimeout(() => {
186-
this.$refs.table.refresh()
186+
this.$refs.table.refresh() // refresh() 不传参默认值 false 不刷新到分页第一页
187187
}, 1500)
188188
189189
}
@@ -199,14 +199,26 @@ Table 重封装组件说明
199199

200200
通过 `this.$refs.table` 调用
201201

202-
`this.$refs.table.refresh()` 刷新列表 (用户新增/修改数据后,重载列表数据)
202+
`this.$refs.table.refresh(true)` 刷新列表 (用户新增/修改数据后,重载列表数据)
203203

204-
> 注意:要调用 `refresh()` 需要给表格组件设定 `ref`
204+
> 注意:要调用 `refresh(bool)` 需要给表格组件设定 `ref`
205+
>
206+
> `refresh()` 方法可以传一个 `bool` 值,当有传值 或值为 `true` 时,则刷新时会强制刷新到第一页(常用户页面 搜索 按钮进行搜索时,结果从第一页开始分页)
205207
206208

207209
内置属性
208210
----
209-
> 除去 `a-table` 自带属性外,还而外提供了 `alert` `props` 属性
211+
> 除去 `a-table` 自带属性外,还而外提供了一些额外属性属性
212+
| 属性 | 说明 | 类型 | 默认值 |
213+
| -------------- | ----------------------------------------------- | ----------------- | ------ |
214+
| alert | 设置是否显示表格信息栏 | [object, boolean] | null |
215+
| showPagination | 显示分页选择器,可传 'auto' \| boolean | [string, boolean] | 'auto' |
216+
| data | 加载数据方法 必须为 `Promise` 对象 **必须绑定** | Promise | - |
217+
218+
219+
220+
`alert` 属性对象:
221+
210222
```javascript
211223
alert: {
212224
show: Boolean,
@@ -220,7 +232,7 @@ alert: {
220232
> 你可能需要为了与后端提供的接口返回结果一致而去修改以下代码:
221233
(需要注意的是,这里的修改是全局性的,意味着整个项目所有使用该 table 组件都需要遵守这个返回结果定义的字段。)
222234

223-
修改 `@/components/table/index.js`124 行起
235+
修改 `@/components/table/index.js`132 行起
224236

225237

226238

@@ -317,4 +329,4 @@ result.then(r => {
317329
更新时间
318330
----
319331

320-
该文档最后更新于: 2018-10-31 PM 08:15
332+
该文档最后更新于: 2019-01-21 AM 08:37

0 commit comments

Comments
 (0)