Skip to content

Commit 316b349

Browse files
committed
docs: add plugin options part for api page
1 parent 1668c41 commit 316b349

File tree

2 files changed

+150
-0
lines changed

2 files changed

+150
-0
lines changed

docs/api/README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,78 @@ Inform the comopnent that this loading failed, the content of `error` slot will
108108
#### $state.reset
109109

110110
Reset the component, same as changing the `identifier` property.
111+
112+
## Options
113+
114+
You can configure all these plugin options via the plugin API.
115+
116+
### props.spinner
117+
118+
- Type: `String`
119+
- Details:
120+
121+
Configure the default value for `spinner` property.
122+
123+
- See also: [Properties - spinner](#spinner)
124+
125+
### props.distance
126+
127+
- Type: `Number`
128+
- Details:
129+
130+
Configure the default value for `distance` property.
131+
132+
- See also: [Properties - distance](#distance)
133+
134+
### props.forceUseInfiniteWrapper
135+
136+
- Type: `Boolean` | `String`
137+
- Details:
138+
139+
Configure the default value for `forceUseInfiniteWrapper` property.
140+
141+
- See also: [Properties - forceUseInfiniteWrapper](#forceuseinfinitewrapper)
142+
143+
### slots.noResults
144+
145+
- Type: `String` | `Vue Component`
146+
- Details:
147+
148+
Configure the default content for `no-results` slot.
149+
150+
- See also: [Slots - no-results](#no-results)
151+
152+
### slots.noMore
153+
154+
- Type: `String` | `Vue Component`
155+
- Details:
156+
157+
Configure the default content for `no-more` slot.
158+
159+
- See also: [Slots - no-more](#no-more)
160+
161+
### slots.error
162+
163+
- Type: `String` | `Vue Component`
164+
- Details:
165+
166+
Configure the default content for `error` slot.
167+
168+
- See also: [Slots - error](#error)
169+
170+
### slots.spinner
171+
172+
- Type: `String` | `Vue Component`
173+
- Details:
174+
175+
Configure the default content for `spinner` slot.
176+
177+
- See also: [Slots - spinner](#spinner-2)
178+
179+
### system.throttleLimit
180+
181+
- Type: `Number`
182+
- Default: `50`
183+
- Details:
184+
185+
Configure the default throttle space of time for `scroll` event (unit: ms).

docs/zh/api/README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,78 @@ sidebar: auto
108108
#### $state.reset
109109

110110
重设组件状态,等同于改变 `identifier` 属性。
111+
112+
## 选项
113+
114+
你可以通过插件 API 配置所有的插件选项。
115+
116+
### props.spinner
117+
118+
- 类型:`String` | `Vue Component`
119+
- 详细:
120+
121+
配置 `spinner` 属性的默认值。
122+
123+
- 参考:[属性 - spinner](#spinner)
124+
125+
### props.distance
126+
127+
- 类型:`Number`
128+
- 详细:
129+
130+
配置 `distance` 属性的默认值。
131+
132+
- 参考:[属性 - distance](#distance)
133+
134+
### props.forceUseInfiniteWrapper
135+
136+
- 类型:`Boolean` | `String`
137+
- 详细:
138+
139+
配置 `forceUseInfiniteWrapper` 属性的默认值。
140+
141+
- 参考:[属性 - forceUseInfiniteWrapper](#forceuseinfinitewrapper)
142+
143+
### slots.noResults
144+
145+
- 类型:`String` | `Vue Component`
146+
- 详细:
147+
148+
配置 `no-results` 插槽的默认内容。
149+
150+
- 参考:[插槽 - no-results](#no-results)
151+
152+
### slots.noMore
153+
154+
- 类型:`String` | `Vue Component`
155+
- 详细:
156+
157+
配置 `no-more` 插槽的默认内容。
158+
159+
- 参考:[插槽 - no-more](#no-more)
160+
161+
### slots.error
162+
163+
- 类型:`String` | `Vue Component`
164+
- 详细:
165+
166+
配置 `error` 插槽的默认内容。
167+
168+
- 参考:[插槽 - error](#error)
169+
170+
### slots.spinner
171+
172+
- 类型:`String` | `Vue Component`
173+
- 详细:
174+
175+
配置 `spinner` 插槽的默认内容。
176+
177+
- 参考:[插槽 - spinner](#spinner-2)
178+
179+
### system.throttleLimit
180+
181+
- 类型:`Number`
182+
- 默认值:`50`
183+
- 详细:
184+
185+
配置 `scroll` 事件节流的间隔时间(单位:毫秒)。

0 commit comments

Comments
 (0)