mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
91 lines
2.1 KiB
Markdown
91 lines
2.1 KiB
Markdown
## Search
|
||
|
||
### Install
|
||
``` javascript
|
||
import { Search } from 'vant';
|
||
|
||
Vue.use(Search);
|
||
```
|
||
|
||
### Usage
|
||
|
||
#### Basic Usage
|
||
|
||
```html
|
||
<van-search placeholder="Placeholder" v-model="value" />
|
||
```
|
||
|
||
```javascript
|
||
export default {
|
||
data() {
|
||
value: ''
|
||
}
|
||
}
|
||
```
|
||
|
||
#### Listen to Events
|
||
`search` event will be triggered when click the search button on the keyboard.
|
||
|
||
`cancel` event will be triggered when click the cancel button.
|
||
|
||
Tips: There will be a search button on the keyboard when Search is inside a form in iOS.
|
||
|
||
```html
|
||
<form action="/">
|
||
<van-search
|
||
v-model="value"
|
||
placeholder="Placeholder"
|
||
show-action
|
||
@search="onSearch"
|
||
@cancel="onCancel"
|
||
/>
|
||
</form>
|
||
```
|
||
|
||
#### Custom Button
|
||
Use `action` slot to custom right button, `cancel` event will no longer be triggered when use this slot
|
||
|
||
```html
|
||
<van-search
|
||
v-model="value"
|
||
show-action
|
||
shape="round"
|
||
@search="onSearch"
|
||
>
|
||
<div slot="action" @click="onSearch">Search</div>
|
||
</van-search>
|
||
```
|
||
|
||
### API
|
||
|
||
Search support all native properties of input tag，such as `maxlength`、`placeholder`、`autofocus`
|
||
|
||
| Attribute | Description | Type | Default |
|
||
|------|------|------|------|
|
||
| label | Search label | `String` | - |
|
||
| shape | Can be set to `round` | `String` | `square` |
|
||
| background | Background color | `String` | `#f2f2f2` |
|
||
| show-action | Whether to show right button | `Boolean` | `false` |
|
||
| disabled | Whether to disable field | `Boolean` | `false` |
|
||
| readonly | Whether to be readonly | `Boolean` | `false` |
|
||
| error | Whether to show error info | `Boolean` | `false` |
|
||
| input-align | Input text align, can be set to `center` `right` | `String` | `left` |
|
||
|
||
### Event
|
||
|
||
Search support all native events of input tag，such as `focus`、`blur`、`keypress`
|
||
|
||
| Event | Description | Arguments |
|
||
|------|------|------|
|
||
| cancel | Triggered when click cancel button | - |
|
||
| search | Triggered when confirm search | - |
|
||
| clear | Triggered when click clear icon | - |
|
||
|
||
### Slot
|
||
|
||
| name | Description |
|
||
|------|------|
|
||
| action | Custom right button, displayed when `showAction` is true |
|
||
| left-icon | Custom left icon |
|
||
| label | Custom Search label |
|