[Doc] add english document of all basic components
This commit is contained in:
@@ -2,29 +2,26 @@
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
search: '',
|
||||
basicSearch: '',
|
||||
slotSearch: ''
|
||||
value: '',
|
||||
};
|
||||
},
|
||||
|
||||
methods: {
|
||||
goSearch() {
|
||||
alert(this.search);
|
||||
onSearch() {
|
||||
Toast(this.value);
|
||||
},
|
||||
goSlotSearch() {
|
||||
alert(this.slotSearch);
|
||||
},
|
||||
handleCancel() {
|
||||
alert('cancel');
|
||||
onCancel() {
|
||||
Toast('cancel');
|
||||
}
|
||||
}
|
||||
};
|
||||
</script>
|
||||
|
||||
<style>
|
||||
.demo-search-action {
|
||||
padding: 0 10px;
|
||||
.demo-search {
|
||||
.van-search__action div {
|
||||
padding: 0 10px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -40,17 +37,15 @@ Vue.component(Search.name, Search);
|
||||
### 代码演示
|
||||
|
||||
#### 基础用法
|
||||
|
||||
`van-search` 中,v-model 用于控制搜索框中的文字。background 可以自定义搜索框外部背景色。
|
||||
|
||||
:::demo 基础用法
|
||||
```html
|
||||
<van-search placeholder="搜索框基础用法" v-model="basicSearch" background="transparent"></van-search>
|
||||
<van-search placeholder="搜索框基础用法" v-model="basicSearch" />
|
||||
```
|
||||
:::
|
||||
|
||||
#### 监听对应事件
|
||||
|
||||
`van-search` 提供了 search 和 cancel 事件。search 事件在用户点击键盘上的 搜索/回车 按钮触发。cancel 事件在用户点击搜索框右侧取消按钮时触发
|
||||
|
||||
Tips: 在 `van-search` 外层增加 form 标签,并且 action 不为空,即可在 IOS 弹出的输入法中显示搜索按钮
|
||||
@@ -59,28 +54,26 @@ Tips: 在 `van-search` 外层增加 form 标签,并且 action 不为空,即
|
||||
```html
|
||||
<form action="/">
|
||||
<van-search
|
||||
v-model="value"
|
||||
placeholder="请输入商品名称"
|
||||
v-model="search"
|
||||
:show-action="true"
|
||||
@search="goSearch"
|
||||
@cancel="handleCancel"></van-search>
|
||||
@search="onSearch"
|
||||
@cancel="onCancel">
|
||||
</van-search>
|
||||
</form>
|
||||
```
|
||||
:::
|
||||
|
||||
#### 自定义行动按钮
|
||||
|
||||
`van-search` 支持自定义右侧取消按钮,使用名字为 action 的 slot 即可。使用此 slot 以后,原有的 cancel 事件不再生效。
|
||||
|
||||
:::demo 自定义行动按钮
|
||||
```html
|
||||
<van-search
|
||||
v-model="slotSearch"
|
||||
v-model="value"
|
||||
:show-action="true"
|
||||
@search="goSlotSearch">
|
||||
<template slot="action">
|
||||
<div class="demo-search-action" @click="goSlotSearch">搜索</div>
|
||||
</template>
|
||||
@search="onSearch">
|
||||
<div slot="action" @click="goSlotSearch">搜索</div>
|
||||
</van-search>
|
||||
```
|
||||
:::
|
||||
@@ -89,9 +82,9 @@ Tips: 在 `van-search` 外层增加 form 标签,并且 action 不为空,即
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|
||||
|-----------|-----------|-----------|-------------|-------------|
|
||||
| placeholder | `input`的`placeholder`文案 | `String` | | |
|
||||
| background | 搜索框背景色 | `String` | `#f2f2f2` | 所有浏览器支持的颜色描述 |
|
||||
| showAction | 是否在搜索框右侧显示取消按钮 | `Boolean` | false | |
|
||||
| placeholder | `input`的`placeholder`文案 | `String` | - | - |
|
||||
| background | 搜索框背景色 | `String` | `#f2f2f2` | 所有浏览器支持的颜色描述 |
|
||||
| showAction | 是否在搜索框右侧显示取消按钮 | `Boolean` | false | - |
|
||||
|
||||
### Event
|
||||
|
||||
|
||||
Reference in New Issue
Block a user