blackteay/vant-weapp
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant-weapp.git synced 2025-05-22 22:49:16 +08:00
Code Issues Projects Releases Wiki Activity

[Doc] fix search doc

Browse Source
This commit is contained in:
陈嘉涵 2018-08-16 09:58:33 +08:00
parent f32647cae3
commit bdb0e6d2db
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
packages/search/README.md
View File

@ -20,11 +20,11 @@ Search 提供了 search 和 cancel 事件。search 事件在用户点击键盘
```html ```html
<van-search <van-search
v-model="value" value="{{ value }}"
placeholder="请输入搜索关键词" placeholder="请输入搜索关键词"
show-action show-action
@search="onSearch" bind:search="onSearch"
@cancel="onCancel" bind:cancel="onCancel"
/> />
``` ```
@ -34,28 +34,27 @@ Search 支持自定义右侧取消按钮，使用名字为 action 的 slot 即
```html ```html
<van-search <van-search
v-model="value" value="{{ value }}"
placeholder="请输入搜索关键词" placeholder="请输入搜索关键词"
use-action-slot use-action-slot
@search="onSearch" bind:search="onSearch"
> >
<view slot="action" bind:tap="onSearch">搜索</view> <view slot="action" bind:tap="onSearch">搜索</view>
</van-search> </van-search>
``` ```
### API ### API
Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`readony`、`autofocus` 等
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------| |-----------|-----------|-----------|-------------|
| value | 当前输入的值 | `String | Number` | - | | value | 当前输入的值 | `String | Number` | - |
| background | 搜索框背景色 | `String` | `#f2f2f2` | | background | 搜索框背景色 | `String` | `#f2f2f2` |
| show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | `false` | | show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | `false` |
| use-action-slot | 是否使用 action slot | `Boolean` | `false` | | focus | 获取焦点 | `Boolean` | `false` |
| disabled | 是否禁用输入框 | `Boolean` | `false` | | disabled | 是否禁用输入框 | `Boolean` | `false` |
| readonly | 是否只读 | `Boolean` | `false` | | readonly | 是否只读 | `Boolean` | `false` |
| maxlength | 最大输入长度，设置为 -1 的时候不限制最大长度 | `Number` | `-1` | | maxlength | 最大输入长度，设置为 -1 的时候不限制最大长度 | `Number` | `-1` |
| focus | 获取焦点 | `Boolean` | `false` | | use-action-slot | 是否使用 action slot | `Boolean` | `false` |
### Event ### Event
Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等 Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等