blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

docs: fix typo in v2 document (#9865)

Browse Source
This commit is contained in:
neverland 2021-11-15 11:50:53 +08:00 committed by GitHub
parent 91e243816e
commit e23b267580
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/markdown/changelog.en-US.md
View File

@ -231,7 +231,7 @@ Vant follows [Semantic Versioning 2.0.0](https://semver.org/lang/zh-CN/).
**Bug Fixes**
- Field: should not reset validation after blured [#8412](https://github.com/youzan/vant/issues/8412)
- Field: should not reset validation after blurred [#8412](https://github.com/youzan/vant/issues/8412)
- Tabs: fix incorrect horizontal slip judgment [#8387](https://github.com/youzan/vant/issues/8387)
### [v2.12.10](https://github.com/youzan/vant/compare/v2.12.9...v2.12.10)

12
src/address-list/README.md
View File

@ -105,12 +105,12 @@ export default {
### Slots
| Name | Description | SlotProps |
| -------------------- | --------------------------------- | --------- |
| default | Custom content after list | - |
| top | Custom content before list | - |
| item-bottom `v2.5.0` | Custom content after list item | item |
| tag `v2.12.9` | Custom tag conetent for list item | item |
| Name | Description | SlotProps |
| -------------------- | -------------------------------- | --------- |
| default | Custom content after list | - |
| top | Custom content before list | - |
| item-bottom `v2.5.0` | Custom content after list item | item |
| tag `v2.12.9` | Custom tag content for list item | item |
### Less Variables

2
src/area/README.md
View File

@ -17,7 +17,7 @@ Vue.use(Area);
### Basic Usage
To initailize `Area` component, `area-list` property is required.
To initialize `Area` component, `area-list` property is required.
```html
<van-area title="Title" :area-list="areaList" />

4
src/button/README.md
View File

@ -38,8 +38,8 @@ Vue.use(Button);
### Disabled
```html
<van-button disabled type="primary">Diabled</van-button>
<van-button disabled type="info">Diabled</van-button>
<van-button disabled type="primary">Disabled</van-button>
<van-button disabled type="info">Disabled</van-button>
```
### Loading

4
src/calendar/README.md
View File

@ -266,7 +266,7 @@ Following props are supported when the type is range
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| max-range | Number of selectable days | _number \| string_ | Unlimitied |
| max-range | Number of selectable days | _number \| string_ | Unlimited |
| range-prompt | Error message when exceeded max range | _string_ | `Choose no more than xx days` |
| allow-same-day `v2.5.6` | Whether the start and end time of the range is allowed on the same day | _boolean_ | `false` |
@ -276,7 +276,7 @@ Following props are supported when the type is multiple
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| max-range `v2.7.2` | Max count of selectable days | _number \| string_ | Unlimitied |
| max-range `v2.7.2` | Max count of selectable days | _number \| string_ | Unlimited |
| range-prompt | Error message when exceeded max count | _string_ | `Choose no more than xx days` |
### Data Structure of Day

2
src/collapse/README.md
View File

@ -58,7 +58,7 @@ export default {
### Disabled
Use the `disabled` prop to disable CollaseItem.
Use the `disabled` prop to disable CollapseItem.
```html
<van-collapse v-model="activeNames">

2
src/empty/README.md
View File

@ -69,7 +69,7 @@ Use the image prop to display different placeholder images.
| --- | --- | --- | --- |
| image | Image type，can be set to `error` `network` `search` or image URL | _string_ | `default` |
| image-size `v2.10.11` | Image size | _number \| string_ | - |
| description | Desciption | _string_ | - |
| description | Description | _string_ | - |
### Slots

8
src/image-preview/README.md
View File

@ -129,7 +129,7 @@ export default {
| closeable `v2.5.0` | Whether to show close icon | _boolean_ | `false` |
| closeIcon `v2.5.0` | Close icon name | _string_ | `clear` |
| closeIconPosition `v2.5.0` | Close icon position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v2.12.8` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| transition `v2.12.8` | Transition, equivalent to `name` prop of [transition](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| getContainer | Return the mount node for ImagePreview | _string \| () => Element_ | - |
### Props
@ -150,7 +150,7 @@ export default {
| closeable `v2.5.0` | Whether to show close icon | _boolean_ | `false` |
| close-icon `v2.5.0` | Close icon name | _string_ | `clear` |
| close-icon-position `v2.5.0` | Close icon position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v2.12.8` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| transition `v2.12.8` | Transition, equivalent to `name` prop of [transition](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| get-container | Return the mount node for ImagePreview | _string \| () => Element_ | - |
### Events
@ -177,14 +177,14 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get ImagePreview instance and call i
| index | Custom index | { index: index of current image } |
| cover | Custom content that covers the image preview | - |
### onClose Parematers
### onClose Parameters
| Attribute | Description | Type |
| --------- | ---------------------- | -------- |
| url | Url of current image | _number_ |
| index | Index of current image | _number_ |
### onScale Parematers
### onScale Parameters
| Attribute | Description | Type |
| --------- | ---------------------- | -------- |

4
src/image-preview/README.zh-CN.md
View File

@ -165,7 +165,7 @@ export default {
| closeable `v2.5.0` | 是否显示关闭图标 | _boolean_ | `false` |
| closeIcon `v2.5.0` | 关闭图标名称或图片链接 | _string_ | `clear` |
| closeIconPosition `v2.5.0` | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v2.12.8` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| transition `v2.12.8` | 动画类名，等价于 [transition](https://cn.vuejs.org/v2/api/index.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| () => Element_ | - |
### Props
@ -188,7 +188,7 @@ export default {
| closeable `v2.5.0` | 是否显示关闭图标 | _boolean_ | `false` |
| close-icon `v2.5.0` | 关闭图标名称或图片链接 | _string_ | `clear` |
| close-icon-position `v2.5.0` | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v2.12.8` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| transition `v2.12.8` | 动画类名，等价于 [transition](https://cn.vuejs.org/v2/api/index.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| () => Element_ | - |
### Events

2
src/image/README.md
View File

@ -85,7 +85,7 @@ Vue.use(Lazyload);
### fit optional value
| name | desctription |
| name | description |
| --- | --- |
| contain | Keep aspect ratio, fully display the long side of the image |
| cover | Keep aspect ratio, fully display the short side of the image, cutting the long side |

2
src/nav-bar/README.md
View File

@ -61,7 +61,7 @@ export default {
| left-arrow | Whether to show left arrow | _boolean_ | `false` |
| border | Whether to show bottom border | _boolean_ | `true` |
| fixed | Whether to fixed top | _boolean_ | `false` |
| placeholder `v2.5.9` | Whether to generage a placeholder element when fixed | _boolean_ | `false` |
| placeholder `v2.5.9` | Whether to generate a placeholder element when fixed | _boolean_ | `false` |
| z-index | Z-index | _number \| string_ | `1` |
| safe-area-inset-top `v2.10.13` | Whether to enable top safe area adaptation | _boolean_ | `false` |

2
src/number-keyboard/README.md
View File

@ -187,7 +187,7 @@ export default {
| input | Emitted when keydown | key: Content of the key |
| delete | Emitted when the delete key is pressed | - |
| close | Emitted when the close button is clicked | - |
| blur | Emitted when the close button is clicked or the keyboard is blured | - |
| blur | Emitted when the close button is clicked or the keyboard is blurred | - |
| show | Emitted when keyboard is fully displayed | - |
| hide | Emitted when keyboard is fully hidden | - |

4
src/number-keyboard/test/index.spec.js
View File

@ -50,7 +50,7 @@ test('click close button', () => {
expect(wrapper.emitted('close')).toBeTruthy();
});
test('listen to show/hide event when has transtion', () => {
test('listen to show/hide event when has transition', () => {
const wrapper = mount(NumberKeyboard);
wrapper.vm.show = true;
wrapper.trigger('animationend');
@ -60,7 +60,7 @@ test('listen to show/hide event when has transtion', () => {
expect(wrapper.emitted('hide')).toBeTruthy();
});
test('listen to show event when no transtion', () => {
test('listen to show event when no transition', () => {
const wrapper = mount(NumberKeyboard, {
propsData: {
transition: false,

2
src/popup/README.md
View File

@ -122,7 +122,7 @@ export default {
| closeable | Whether to show close icon | _boolean_ | `false` |
| close-icon | Close icon name | _string_ | `cross` |
| close-icon-position | Close Icon Position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | _string_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://vuejs.org/v2/api/#transition) | _string_ | - |
| transition-appear `v2.10.14` | Whether to apply transition on initial render | _boolean_ | `false` |
| get-container | Return the mount node for Popup | _string \| () => Element_ | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` |

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

@ -133,7 +133,7 @@ export default {
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
| close-icon | 关闭图标名称或图片链接 | _string_ | `cross` |
| close-icon-position | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | - |
| transition | 动画类名，等价于 [transition](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | - |
| transition-appear `v2.10.14` | 是否在初始渲染时启用过渡动画 | _boolean_ | `false` |
| get-container | 指定挂载的节点 | _string \| () => Element_ | - |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` |

2
src/search/README.md
View File

@ -136,7 +136,7 @@ Use `action` slot to custom right button, `cancel` event will no longer be Emitt
| search | Emitted when confirming search | _value: string_ |
| input | Emitted when input value changed | _value: string_ |
| focus | Emitted when input is focused | _event: Event_ |
| blur | Emitted when input is blured | _event: Event_ |
| blur | Emitted when input is blurred | _event: Event_ |
| clear | Emitted when the clear icon is clicked | _event: Event_ |
| cancel | Emitted when the cancel button is clicked | - |

2
src/sku/README.md
View File

@ -328,7 +328,7 @@ customStepperConfig: {
handleStepperChange: currentValue => {},
// stock
stockNum: 1999,
// stock fomatter
// stock formatter
stockFormatter: stockNum => {},
}
```

2
src/stepper/README.md
View File

@ -142,7 +142,7 @@ export default {
| plus | Emitted when the plus button is clicked | - |
| minus | Emitted when the minus button is clicked | - |
| focus | Emitted when the input is focused | _event: Event_ |
| blur | Emitted when the input is blured | _event: Event_ |
| blur | Emitted when the input is blurred | _event: Event_ |
### Less Variables

4
src/submit-bar/README.md
View File

@ -19,7 +19,7 @@ Vue.use(SubmitBar);
### Disabled
`submit` event will not triggerd when disabled.
`submit` event will not triggered when disabled.
```html
<van-submit-bar
@ -34,7 +34,7 @@ Vue.use(SubmitBar);
### Loading
`submit` event will not triggerd when loading.
`submit` event will not triggered when loading.
```html
<van-submit-bar loading :price="3050" button-text="Submit" @submit="onSubmit" />

12
src/swipe-cell/README.md
View File

@ -117,17 +117,17 @@ export default {
| Event | Description | Arguments |
| --- | --- | --- |
| click | Emitted when SwipeCell is clicked | Click positon (`left` `right` `cell` `outside`) |
| click | Emitted when SwipeCell is clicked | Click position (`left` `right` `cell` `outside`) |
| open | Emitted when SwipeCell is opened | { position: 'left' \| 'right' , name: string } |
| close | Emitted when SwipeCell is closed | { position: string , name: string } |
### beforeClose Params
| Attribute | Description | Type |
| --------- | ----------------------------------------------- | ----------- |
| name | Name | _string_ |
| position | Click positon (`left` `right` `cell` `outside`) | _string_ |
| instance | SwipeCell instance | _SwipeCell_ |
| Attribute | Description | Type |
| --------- | ------------------------------------------------ | ----------- |
| name | Name | _string_ |
| position | Click position (`left` `right` `cell` `outside`) | _string_ |
| instance | SwipeCell instance | _SwipeCell_ |
### Methods

4
src/tab/README.md
View File

@ -163,7 +163,7 @@ Use `animated` props to change tabs with animation.
### Swipeable
In swipeable mode, you can switch tabs with swipe gestrue in the content.
In swipeable mode, you can switch tabs with swipe gesture in the content.
```html
<van-tabs v-model="active" swipeable>
@ -230,7 +230,7 @@ export default {
| border | Whether to show border when `type="line"` | _boolean_ | `false` |
| ellipsis | Whether to ellipsis too long title | _boolean_ | `true` |
| sticky | Whether to use sticky mode | _boolean_ | `false` |
| swipeable | Whether to switch tabs with swipe gestrue in the content | _boolean_ | `false` |
| swipeable | Whether to switch tabs with swipe gesture in the content | _boolean_ | `false` |
| lazy-render | Whether to enable tab content lazy render | _boolean_ | `true` |
| scrollspy | Whether to use scrollspy mode | _boolean_ | `false` |
| offset-top `v2.8.7` | Sticky offset top , supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` |

2
src/tabbar/README.md
View File

@ -154,7 +154,7 @@ export default {
| active-color | Color of active tab item | _string_ | `#1989fa` |
| inactive-color | Color of inactive tab item | _string_ | `#7d7e80` |
| route | Whether to enable route mode | _boolean_ | `false` |
| placeholder `v2.6.0` | Whether to generage a placeholder element when fixed | _boolean_ | `false` |
| placeholder `v2.6.0` | Whether to generate a placeholder element when fixed | _boolean_ | `false` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` |
| before-change `v2.10.4` | Callback function before changing tabs，return `false` to prevent change，support return Promise | _(name) => boolean \| Promise_ | - |

4
src/toast/README.md
View File

@ -144,7 +144,7 @@ Toast.resetDefaultOptions('loading');
| Toast.success | `options | message` | toast instance | Show success toast |
| Toast.fail | `options | message` | toast instance | Show fail toast |
| Toast.clear | `clearAll: boolean` | `void` | Close toast |
| Toast.allowMultiple | - | `void` | Allow multlple toast at the same time |
| Toast.allowMultiple | - | `void` | Allow multiple toast at the same time |
| Toast.setDefaultOptions | `type | options` | `void` | Set default options of all toasts |
| Toast.resetDefaultOptions | `type` | `void` | Reset default options of all toasts |
@ -166,7 +166,7 @@ Toast.resetDefaultOptions('loading');
| className | Custom className | _any_ | - |
| onOpened | Callback function after opened | _Function_ | - |
| onClose | Callback function after close | _Function_ | - |
| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| transition | Transition, equivalent to `name` prop of [transition](https://vuejs.org/v2/api/#transition) | _string_ | `van-fade` |
| getContainer | Return the mount node for Toast | _string \| () => Element_ | `body` |
### Less Variables

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

@ -181,7 +181,7 @@ Toast.resetDefaultOptions('loading');
| className | 自定义类名 | _any_ | - |
| onOpened | 完全展示后的回调函数 | _Function_ | - |
| onClose | 关闭时的回调函数 | _Function_ | - |
| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | `van-fade` |
| transition | 动画类名，等价于 [transition](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | `van-fade` |
| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| () => Element_ | `body` |
### 样式变量