mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-11-04 21:02:09 +08:00
93 lines
2.8 KiB
Markdown
93 lines
2.8 KiB
Markdown
# Search 搜索
|
||
|
||
### 引入
|
||
|
||
``` javascript
|
||
import { Search } from 'vant';
|
||
|
||
Vue.use(Search);
|
||
```
|
||
|
||
## 代码演示
|
||
|
||
### 基础用法
|
||
|
||
`van-search` 中，v-model 用于控制搜索框中的文字。background 可以自定义搜索框外部背景色。
|
||
|
||
```html
|
||
<van-search placeholder="请输入搜索关键词" v-model="value" />
|
||
```
|
||
|
||
### 监听对应事件
|
||
|
||
`van-search` 提供了 search 和 cancel 事件。search 事件在用户点击键盘上的 搜索/回车 按钮触发。cancel 事件在用户点击搜索框右侧取消按钮时触发
|
||
|
||
Tips: 在 `van-search` 外层增加 form 标签，并且 action 不为空，即可在 IOS 弹出的输入法中显示搜索按钮
|
||
|
||
```html
|
||
<form action="/">
|
||
<van-search
|
||
v-model="value"
|
||
placeholder="请输入搜索关键词"
|
||
show-action
|
||
@search="onSearch"
|
||
@cancel="onCancel"
|
||
/>
|
||
</form>
|
||
```
|
||
|
||
### 自定义行动按钮
|
||
|
||
`van-search` 支持自定义右侧取消按钮，使用名字为 action 的插槽即可。使用此插槽以后，原有的 cancel 事件不再生效。
|
||
|
||
```html
|
||
<van-search
|
||
v-model="value"
|
||
placeholder="请输入搜索关键词"
|
||
show-action
|
||
shape="round"
|
||
@search="onSearch"
|
||
>
|
||
<div slot="action" @click="onSearch">搜索</div>
|
||
</van-search>
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`autofocus` 等
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
|------|------|------|------|------|
|
||
| label | 搜索框左侧文本 | `String` | - | 1.6.6 |
|
||
| shape | 形状，可选值为 `round` | `String` | `square` | 1.6.6 |
|
||
| background | 搜索框背景色 | `String` | `#f2f2f2` | - |
|
||
| clearable | 是否启用清除控件 | `Boolean` | `true` | 2.0.0 |
|
||
| show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | `false` | - |
|
||
| disabled | 是否禁用输入框 | `Boolean` | `false` | - |
|
||
| readonly | 是否将输入框设为只读 | `Boolean` | `false` | - |
|
||
| error | 是否将输入内容标红 | `Boolean` | `false` | - |
|
||
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | `String` | `left` | - |
|
||
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | `search` | 2.0.0 |
|
||
| right-icon | 输入框右侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 2.0.0 |
|
||
|
||
### Events
|
||
|
||
Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等
|
||
|
||
| 事件名 | 说明 | 回调参数 |
|
||
|------|------|------|
|
||
| cancel | 取消搜索 | - |
|
||
| search | 确定搜索 | - |
|
||
| clear | 点击清除按钮后触发 | - |
|
||
|
||
### Slots
|
||
|
||
| 名称 | 说明 |
|
||
|------|------|
|
||
| label | 自定义搜索框左侧文本 |
|
||
| action | 自定义搜索框右侧按钮，需要在`showAction`为 true 时才会显示 |
|
||
| left-icon | 自定义输入框左侧图标 |
|
||
| right-icon | 自定义输入框右侧图标 |
|