Skip to content

Commit 2d12d9a

Browse files
committed
docs: add priority explanation for global options
1 parent 32aa905 commit 2d12d9a

File tree

4 files changed

+15
-3
lines changed

4 files changed

+15
-3
lines changed

docs/api/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ Reset the component, same as changing the `identifier` property.
119119

120120
You can configure all these plugin options via the plugin API.
121121

122+
- See also: [Configure Plugin Options](../guide/configure-plugin-opts.md)
123+
122124
### props.spinner
123125

124126
- Type: `String`
@@ -135,6 +137,10 @@ Configure the default value for `spinner` property.
135137

136138
Configure the default value for `distance` property.
137139

140+
::: warning
141+
This option is read with a lower priority than [Options - slots.spinner](#slots-spinner), it means if you configure `slots.spinner` correctly, this option will never take effect
142+
:::
143+
138144
- See also: [Properties - distance](#distance)
139145

140146
### props.forceUseInfiniteWrapper

docs/guide/configure-plugin-opts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configure Plugin Options
22

3-
We can configure default properties, default slots and default system settings for this plugin via the plugin API, they will apply for all the `InfiniteLoading` components in your project.
3+
We can configure default properties, default slots and default system settings for this plugin via the plugin API, they will be the default values for all the `InfiniteLoading` components in your project, you can still override them through property or slot in every component.
44

55
## Props/Settings
66

docs/zh/api/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,19 @@ sidebar: auto
119119

120120
你可以通过插件 API 配置所有的插件选项。
121121

122+
- 参考:[配置插件选项](../guide/configure-plugin-opts.md)
123+
122124
### props.spinner
123125

124-
- 类型:`String` | `Vue Component`
126+
- 类型:`String`
125127
- 详细:
126128

127129
配置 `spinner` 属性的默认值。
128130

131+
::: warning 注意
132+
该配置被读取的优先级低于 [选项 - slots.spinner](#slots-spinner),这意味着如果你正确配置了 `slots.spinner`,该配置就永远不会生效
133+
:::
134+
129135
- 参考:[属性 - spinner](#spinner)
130136

131137
### props.distance

docs/zh/guide/configure-plugin-opts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 配置插件选项
22

3-
我们可以通过插件 API 配置该插件的默认属性、默认插槽以及默认系统配置,它们会被应用到你项目中的所有 `InfiniteLoading` 组件上
3+
我们可以通过插件 API 配置该插件的默认属性、默认插槽以及默认系统配置,它们将会作为你项目中的所有 `InfiniteLoading` 组件的默认值,你仍然可以通过每个组件的属性及插槽对它们进行覆盖
44

55
## 属性/设置
66

0 commit comments

Comments
 (0)