[Improvement] Reorganize document (#1066)

2018-05-15 10:39:01 +08:00
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
@@ -0,0 +1,79 @@
+## 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
+  @search="onSearch"
+>
+  <div slot="action" @click="onSearch">Search</div>
+</van-search>
+```
+
+### API
+Search support all native properties of input tag，such as `maxlength`、`placeholder`、`readonly`、`autofocus`
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| placeholder | Input placeholder | `String` | - |
+| background | Background color | `String` | `#f2f2f2` |
+| show-action | Whether to show right button | `Boolean` | `false` |
+
+### 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 | - |
+
+### Slot
+
+| name | Description |
+|-----------|-----------|
+| action | Custom right button, displayed when `showAction` is true |
@@ -0,0 +1,69 @@
+## 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 的 slot 即可。使用此 slot 以后，原有的 cancel 事件不再生效。
+
+```html
+<van-search
+  v-model="value"
+  show-action
+  @search="onSearch"
+>
+  <div slot="action" @click="onSearch">搜索</div>
+</van-search>
+```
+
+### API
+Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`readony`、`autofocus` 等
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| background | 搜索框背景色 | `String` | `#f2f2f2` |
+| show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | `false` |
+
+### Event
+Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等
+
+| 事件名 | 说明 | 参数 |
+|-----------|-----------|-----------|
+| cancel | 取消搜索 | - |
+| search | 确定搜索 | - |
+
+### Slot
+
+| 名称 | 说明 |
+|-----------|-----------|
+| action | 自定义搜索框右侧按钮，需要在`showAction`为 true 时才会显示 |