blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs(IndexBar): fix repeated methods (#9182)

Browse Source
This commit is contained in:
neverland 2021-08-04 16:13:44 +08:00 committed by GitHub
parent 76de1680b1
commit d36b4a901d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/index-bar/README.md
View File

@ -91,13 +91,7 @@ export default {
| select | Emitted when an index is selected | _index: number \| string_ | | select | Emitted when an index is selected | _index: number \| string_ |
| change | Emitted when active index changed | _index: number \| string_ | | change | Emitted when active index changed | _index: number \| string_ |
### IndexAnchor Slots ### IndexBar Methods
| Name | Description |
| ------- | ------------------------------------- |
| default | Anchor content, show index by default |
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get IndexBar instance and call instance methods. Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get IndexBar instance and call instance methods.
@ -105,6 +99,12 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get IndexB
| --- | --- | --- | --- | | --- | --- | --- | --- |
| scrollTo | scroll to target element | _index: number \| string_ | - | | scrollTo | scroll to target element | _index: number \| string_ | - |
### IndexAnchor Slots
| Name | Description |
| ------- | ------------------------------------- |
| default | Anchor content, show index by default |
### CSS Variables ### CSS Variables
The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider). The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider).

10
src/index-bar/README.zh-CN.md
View File

@ -95,7 +95,7 @@ export default {
| select | 点击索引栏的字符时触发 | _index: number \| string_ | | select | 点击索引栏的字符时触发 | _index: number \| string_ |
| change | 当前高亮的索引字符变化时触发 | _index: number \| string_ | | change | 当前高亮的索引字符变化时触发 | _index: number \| string_ |
### 方法 ### IndexBar 方法
通过 ref 可以获取到 IndexBar 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。 通过 ref 可以获取到 IndexBar 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。
@ -109,14 +109,6 @@ export default {
| ------- | -------------------------------- | | ------- | -------------------------------- |
| default | 锚点位置显示内容，默认为索引字符 | | default | 锚点位置显示内容，默认为索引字符 |
### IndexBar 方法
通过 ref 可以获取到 IndexBar 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。
| 方法名 | 说明 | 参数 | 返回值 |
| -------- | -------------- | ------------------------- | ------ |
| scrollTo | 滚动到指定锚点 | _index: number \| string_ | - |
### 样式变量 ### 样式变量
组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。 组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。