ui/vant
1
0
Fork 0
mirror of https://github.com/youzan/vant.git synced 2025-10-22 03:44:48 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:09:00 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -52,10 +52,10 @@ Vue.use(IndexAnchor);
export default {
data() {
return {
indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
}
}
}
indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
};
},
};
```
## API
@@ -63,27 +63,27 @@ export default {
### IndexBar Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| index-list | Index List | *string[] \| number[]* | `A-Z` |
| z-index | z-index | *number \| string* | `1` |
| sticky | Whether to enable anchor sticky top | *boolean* | `true` |
| sticky-offset-top `v2.0.7` | Anchor offset top when sticky | *number* | `0` |
| highlight-color | Index character highlight color | *string* | `#07c160` | - |
| --- | --- | --- | --- |
| index-list | Index List | _string[] \| number[]_ | `A-Z` |
| z-index | z-index | _number \| string_ | `1` |
| sticky | Whether to enable anchor sticky top | _boolean_ | `true` |
| sticky-offset-top `v2.0.7` | Anchor offset top when sticky | _number_ | `0` |
| highlight-color | Index character highlight color | _string_ | `#07c160` | - |
### IndexAnchor Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| index | Index | *number \| string* | - |
| Attribute | Description | Type | Default |
| --------- | ----------- | ------------------ | ------- |
| index | Index | _number \| string_ | - |
### IndexBar Events
| Event | Description | Arguments |
|------|------|------|
| select | Triggered when select index | index |
| Event | Description | Arguments |
| ------ | --------------------------- | --------- |
| select | Triggered when select index | index |
### IndexAnchor Slots
| Name | Description |
|------|------|
| Name | Description |
| ------- | ------------------------------------- |
| default | Anchor content, show index by default |

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

@@ -56,10 +56,10 @@ Vue.use(IndexAnchor);
export default {
data() {
return {
indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
}
}
}
indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
};
},
};
```
## API
@@ -67,27 +67,27 @@ export default {
### IndexBar Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| index-list | 索引字符列表 | *string[] \| number[]* | `A-Z` |
| z-index | z-index 层级 | *number \| string* | `1` |
| sticky | 是否开启锚点自动吸顶 | *boolean* | `true` |
| sticky-offset-top `v2.0.7` | 锚点自动吸顶时与顶部的距离 | *number* | `0` |
| highlight-color | 索引字符高亮颜色 | *string* | `#07c160` |
| --- | --- | --- | --- |
| index-list | 索引字符列表 | _string[] \| number[]_ | `A-Z` |
| z-index | z-index 层级 | _number \| string_ | `1` |
| sticky | 是否开启锚点自动吸顶 | _boolean_ | `true` |
| sticky-offset-top `v2.0.7` | 锚点自动吸顶时与顶部的距离 | _number_ | `0` |
| highlight-color | 索引字符高亮颜色 | _string_ | `#07c160` |
### IndexAnchor Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| index | 索引字符 | *number \| string* | - |
| 参数 | 说明 | 类型 | 默认值 |
| ----- | -------- | ------------------ | ------ |
| index | 索引字符 | _number \| string_ | - |
### IndexBar Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| 事件名 | 说明 | 回调参数 |
| ------ | -------------- | --------------- |
| select | 选中字符时触发 | index: 索引字符 |
### IndexAnchor Slots
| 名称 | 说明 |
|------|------|
| 名称 | 说明 |
| ------- | -------------------------------- |
| default | 锚点位置显示内容，默认为索引字符 |