Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
bplok20010 committed Mar 24, 2019
1 parent 65a687e commit d6b904a
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 2 deletions.
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,49 @@
# input
# Input

`npm install --save react-widget-input`

## Api

### Input
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| prefixCls | 组件CSS样式前缀 | string | rw-input |
| className | 组件className属性 | string | - |
| inputClassName | input className属性 | string | - |
| style | 组件style属性 | React.CSSProperties | - |
| inputStyle | input style属性 | React.CSSProperties | - |
| size | 输入框尺寸,可选值为`large``small``default` | string | - |
| append | 带标签的 input,设置后置标签 | string\|ReactNode | |
| appendProps | 设置后置标签属性 | object | |
| prepend | 带标签的 input,设置前置标签 | string\|ReactNode | |
| prependProps | 设置前置标签属性 | object | |
| defaultValue | 输入框默认内容 | string | |
| value | 输入框内容 | string | |
| disabled | 是否禁用状态,默认为 false | boolean | false |
| id | 输入框的 id | string | |
| prefix | 带有前缀图标的 input | string\|ReactNode | |
| prefixProps | 前缀图标属性 | object | |
| suffix | 带有后缀图标的 input | string\|ReactNode | |
| suffixProps | 后缀图标属性 | object | |
| type | 声明 input 类型,同原生 input 标签的 type 属性,见:[MDN](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#属性)| string | `text` |
| onChange | 输入框内容变化时的回调 | function(value,e) | |
| onPressEnter | 按下回车的回调 | function(e) | |
| allowClear | 可以点击清除图标删除内容 | boolean | |

Input 的其他属性和 React 自带的 [input](https://facebook.github.io/react/docs/events.html#supported-events) 一致。

### Search
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| enterButton | 是否有确认按钮,可设为按钮文字。该属性会与 append 冲突。 | boolean\|ReactNode | false |
| onSearch | 点击搜索或按下回车键时的回调 | function(value, event) | |

其余属性和 Input 一致。

### TextArea
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| autosize | 自适应内容高度,可设置为 `true|false` 或对象:`{ minRows: 2, maxRows: 6 }` | boolean\|object | false |

其余属性和 Input 一致。

1 change: 0 additions & 1 deletion src/Input.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ export default class Input extends React.Component {
);
}


renderIconInput() {
const props = this.props;
const {
Expand Down

0 comments on commit d6b904a

Please sign in to comment.