yun-ui/packages/input/README.md

Mobile UI Components Library for Vue.js by yunzhijia.

# Input

表单，单行输入框组件。

### 使用场景

用于表单中创建单行输入框。

> 搭配form组件使用。
> form是最基本的通用表单项组件容器，可用于包含表单项组件。仅作为语义化组件用，没有API，但可在其上监听form内组件的事件变化。

### 引入

``` javascript
import Vue from 'vue'
import {Form, Input} from 'yun-ui'
import 'yun-ui/dist/yun/Form/index.css'
import 'yun-ui/dist/yun/Input/index.css'

Vue.component(Form.name, Form)
Vue.component(Input.name, Input)
```

### 代码示例

``` javascript
<template>
<y-form>
    <y-input placeholder="输入" :limit="60" @change=""></y-input>
    <y-input label="文本" placeholder="提示文本" align="right" @change=""></y-input>
</y-form>
</template>
```

### API

|    参数    |      说明      |    类型    |   可选值    |   默认值   |
|   ----    |      ----      |   ----    |   ----     |  ----     |
|   label   |  输入框项的名称  |   String  |             |           |
| limit     |  输入框限制字数   | Number |               |           |
|defaultValue|   输入框初始值   |   String  |            |            |
|placeholder|  输入框的placeholder|   String  |             |   |
|align|  输入框内的文字对齐方式，默认为左对齐|   String  | right |   |
|    error  | 表单验证错误提示    |   Boolean  | true,false | false |
|  change   | 输入框输入改变时的回调函数，第一个参数为改变后的值，第二个参数为输入框的label。可绑定在input组件，也可绑定在form组件上|   Function |  |  |