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: add more links (#4420)

Browse Source
This commit is contained in:
neverland 2019-09-10 20:27:42 +08:00 committed by GitHub
parent a80773e19e
commit 6069d72df4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/site/desktop/main.js
View File

@ -21,16 +21,16 @@ importAll(docs, docsFromPackages);
const router = new VueRouter({
mode: 'hash',
routes: routes({ componentMap: docs }),
scrollBehavior(to, from, savedPosition) {
scrollBehavior(to) {
if (to.hash) {
return { selector: to.hash };
}
return savedPosition || { x: 0, y: 0 };
return { x: 0, y: 0 };
}
});
router.afterEach(path => {
router.afterEach(() => {
Vue.nextTick(() => window.syncPath());
});

4
src/button/README.zh-CN.md
View File

@ -118,7 +118,7 @@ Vue.use(Button);
| size | 尺寸，可选值为 `large` `small` `mini` | *string* | `normal` | - |
| text | 按钮文字 | *string* | - | - |
| color | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | 2.1.3 |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| tag | HTML 标签 | *string* | `button` | - |
| native-type | 原生 button 标签 type 属性 | *string* | - | - |
| block | 是否为块级元素 | *boolean* | `false` | - |
@ -132,7 +132,7 @@ Vue.use(Button);
| loading-type | 加载图标类型，可选值为`spinner` | *string* | `circular` | - |
| loading-size | 加载图标大小 | *string* | `20px` | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### Events

4
src/cell/README.zh-CN.md
View File

@ -115,13 +115,13 @@ Vue.use(Cell).use(CellGroup);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| title | 左侧标题 | *string \| number* | - | - |
| value | 右侧内容 | *string \| number* | - | - |
| label | 标题下方的描述信息 | *string* | - | - |
| size | 单元格大小，可选值为 `large` | *string* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - |
| border | 是否显示内边框 | *boolean* | `true` | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
| clickable | 是否开启点击反馈 | *boolean* | `false` | - |

2
src/collapse/README.zh-CN.md
View File

@ -105,7 +105,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 唯一标识符，默认为索引值 | *string \| number* | `index` | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| size | 标题栏大小，可选值为 `large` | *string* | - | - |
| title | 标题栏左侧内容 | *string \| number* | - | - |
| value | 标题栏右侧内容 | *string \| number* | - | - |

2
src/dropdown-menu/README.zh-CN.md
View File

@ -157,4 +157,4 @@ export default {
|------|------|------|
| text | 文字 | *string* |
| value | 标识符 | *string \| number* |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* |
| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* |

4
src/field/README.zh-CN.md
View File

@ -148,8 +148,8 @@ Vue.use(Field);
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - |
| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | *string* | `left` | - |
| autosize | 自适应内容高度，只对 textarea 有效，可传入对象,<br>如 { maxHeight: 100, minHeight: 50 }，单位为`px` | *boolean \| object* | `false` | - |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| right-icon | 右侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| left-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| right-icon | 右侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
### Events

4
src/goods-action/README.zh-CN.md
View File

@ -86,7 +86,7 @@ export default {
| icon-class | 图标额外类名 | *any* | - | - |
| info | 图标右上角提示信息 | *string \| number* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### GoodsActionButton Props
@ -99,7 +99,7 @@ export default {
| disabled | 是否禁用按钮 | *boolean* | `false` | - | - |
| loading | 是否显示为加载状态 | *boolean* | `false` | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### GoodsActionIcon Slots

4
src/grid/README.zh-CN.md
View File

@ -130,9 +130,9 @@ Vue.use(Grid).use(GridItem);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| text | 文字 | *string* | - | - |
| icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| icon | 图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### GridItem Events

2
src/notice-bar/README.zh-CN.md
View File

@ -80,7 +80,7 @@ Vue.use(NoticeBar);
| speed | 滚动速率 (px/s) | *number* | `50` | - |
| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` | - |
| wrapable | 是否开启文本换行，只在禁用滚动时生效 | *boolean* | `false` | - |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| left-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| color | 文本颜色 | *string* | `#f60` | - |
| background | 滚动条背景 | *string* | `#fff7cc` | - |

2
src/panel/README.zh-CN.md
View File

@ -44,7 +44,7 @@ Vue.use(Panel);
| title | 标题 | *string* | - | - |
| desc | 描述 | *string* | - | - |
| status | 状态 | *string* | - | - |
| icon | 标题左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| icon | 标题左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
### Slots

4
src/rate/README.zh-CN.md
View File

@ -101,8 +101,8 @@ export default {
| color | 选中时的颜色 | *string* | `#ffd21e` | - |
| void-color | 未选中时的颜色 | *string* | `#c7c7c7` | - |
| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` | - |
| icon | 选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star` | - |
| void-icon | 未选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star-o` | - |
| icon | 选中时的图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | `star` | - |
| void-icon | 未选中时的图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | `star-o` | - |
| allow-half | 是否允许半选 | *boolean* | `false` | - |
| readonly | 是否为只读状态 | *boolean* | `false` | - |
| disabled | 是否禁用评分 | *boolean* | `false` | - |

4
src/search/README.zh-CN.md
View File

@ -70,8 +70,8 @@ Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pl
| readonly | 是否将输入框设为只读 | *boolean* | `false` | - |
| error | 是否将输入内容标红 | *boolean* | `false` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | `search` | - |
| right-icon | 输入框右侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | `search` | - |
| right-icon | 输入框右侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
### Events

2
src/sidebar/README.zh-CN.md
View File

@ -68,7 +68,7 @@ export default {
| info | 提示消息 | *string \| number* | `''` | - |
| disabled | 是否禁用该项 | *boolean* | `false` | 2.2.0 |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | 2.0.4 |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | 2.0.4 |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | 2.0.4 |
### SidebarItem Events

4
src/steps/README.zh-CN.md
View File

@ -79,8 +79,8 @@ export default {
| active | 当前步骤 | *number* | 0 | - |
| direction | 显示方向，可选值为 `vertical` | *string* | `horizontal` | - |
| active-color | 激活状态颜色 | *string* | `#07c160` | - |
| active-icon | 激活状态底部图标，可选值见 Icon 组件 | *string* | `checked` | - |
| inactive-icon | 未激活状态底部图标，可选值见 Icon 组件 | *string* | - | - |
| active-icon | 激活状态底部图标，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | `checked` | - |
| inactive-icon | 未激活状态底部图标，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
### Step Slots

2
src/submit-bar/README.zh-CN.md
View File

@ -78,7 +78,7 @@ Vue.use(SubmitBar);
| button-text | 按钮文字 | *string* | - | - |
| button-type | 按钮类型 | *string* | `danger` | - |
| tip | 提示文案 | *string* | - | - |
| tip-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| tip-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | - |
| disabled | 是否禁用按钮 | *boolean* | `false` | - |
| loading | 是否显示加载中的按钮 | *boolean* | `false` | - |
| currency | 货币符号 | *string* | `¥` | - |

4
src/tabbar/README.zh-CN.md
View File

@ -167,11 +167,11 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 | - |
| icon | 图标名称或图片链接，可选值见 Icon 组件| *string* | - | - |
| icon | 图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon)| *string* | - | - |
| dot | 是否显示小红点 | *boolean* | - | - |
| info | 图标右上角提示信息 | *string \| number* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| to | 路由跳转对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### TabbarItem Slots

2
src/toast/README.zh-CN.md
View File

@ -117,7 +117,7 @@ toast2.clear();
| type | 提示类型，可选值为 `loading` `success`<br>`fail` `html` | *string* | `text` | - |
| position | 位置，可选值为 `top` `bottom` | *string* | `middle` | - |
| message | 文本内容，支持通过`\n`换行 | *string* | `''` | - | - |
| icon | 自定义图标，支持传入图标名称或图片链接，可选值见 Icon 组件 | *string* | - | 2.0.1 |
| icon | 自定义图标，支持传入图标名称或图片链接，可选值见 [Icon 组件](/#/zh-CN/icon) | *string* | - | 2.0.1 |
| iconPrefix | 图标类名前缀 | *string* | `van-icon` | 2.0.9 |
| mask | 是否显示背景遮罩层 | *boolean* | `false` | - |
| forbidClick | 是否禁止背景点击 | *boolean* | `false` | - |