Skip to content

Commit 1668c41

Browse files
committed
docs: add spinner slot description in api page
1 parent e0c0b7c commit 1668c41

File tree

2 files changed

+12
-18
lines changed

2 files changed

+12
-18
lines changed

docs/api/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,17 @@ This message will be displayed if there is no more data, it means we called the
7272

7373
### error
7474

75-
- Default: `Opps, something went wrong :(`
75+
- Default: `Opps, something went wrong :( <br> <button>Retry</button>`
7676
- Details:
7777

7878
This message will be displayed if loading failed, it means we called the `$state.error` method.
7979

80-
Unlike other slots, the default value for this slot will provide a retry button for users to load data again. If you want to impletement a retry button for users when you customize this slot, you can use the [`slot-scope`](https://vuejs.org/v2/api/index.html#slot-scope) feature, like this:
80+
### spinner
81+
82+
- Default: `Internal Spinner`
83+
- Details:
8184

82-
``` html
83-
<infinite-loading @infinite="infiniteHandler">
84-
<div slot="error" slot-scope="{ trigger }">
85-
Network error, click <a href="javascript:;" @click="trigger">here</a> to retry
86-
</div>
87-
</infinite-loading>
88-
```
85+
This slot will be displayed when loading data, you can customize your own spinner through it.
8986

9087
## Events
9188

docs/zh/api/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,17 @@ sidebar: auto
7272

7373
### error
7474

75-
- 默认值:`Opps, something went wrong :(`
75+
- 默认值:`Opps, something went wrong :( <br> <button>Retry</button>`
7676
- 详细:
7777

7878
该信息将会在加载出现错误时呈现给用户,即调用 `$state.error` 方法时。
7979

80-
与其他插槽不同的是,该插槽的默认值除了会提供文字信息之外,还会提供一个重试按钮供用户重新尝试加载;在自定义该插槽时,如果你也希望提供一个重试按钮给用户,可以使用 [`slot-scope`](https://vuejs.org/v2/api/index.html#slot-scope) 功能实现,就像下面这样:
80+
### spinner
81+
82+
- 默认值:`Internal Spinner`
83+
- 详细:
8184

82-
``` html
83-
<infinite-loading @infinite="infiniteHandler">
84-
<div slot="error" slot-scope="{ trigger }">
85-
Network error, click <a href="javascript:;" @click="trigger">here</a> to retry
86-
</div>
87-
</infinite-loading>
88-
```
85+
此插槽将会在加载数据时展示,你可以通过它自定义加载动画。
8986

9087
## 事件
9188

0 commit comments

Comments
 (0)