1 | # zooid-input
|
2 | A React component to render Zooid like text inputs.
|
3 |
|
4 | [![Build Status](https://travis-ci.org/octoblu/zooid-input.svg?branch=master)](https://travis-ci.org/octoblu/zooid-input)
|
5 | [![Test Coverage](https://codecov.io/gh/octoblu/zooid-input/branch/master/graph/badge.svg)](https://codecov.io/gh/octoblu/zooid-input)
|
6 | [![Dependency status](http://img.shields.io/david/octoblu/zooid-input.svg?style=flat)](https://david-dm.org/octoblu/zooid-input)
|
7 | [![devDependency Status](http://img.shields.io/david/dev/octoblu/zooid-input.svg?style=flat)](https://david-dm.org/octoblu/zooid-input#info=devDependencies)
|
8 | [![Slack Status](http://community-slack.octoblu.com/badge.svg)](http://community-slack.octoblu.com)
|
9 |
|
10 | [![NPM](https://nodei.co/npm/zooid-input.svg?style=flat)](https://npmjs.org/package/zooid-input)
|
11 |
|
12 |
|
13 |
|
14 | ### Install
|
15 | ```
|
16 | npm install --save zooid-input
|
17 | ```
|
18 | ### Props
|
19 | | Prop | Type | Default | Description |
|
20 | | ----------- | -------| --------| -------------------------------------|
|
21 | | className | string | | Additional css classes for your input|
|
22 | | disabled | bool | false | Disables the text input |
|
23 | | label | string | | The label for the text input |
|
24 | | name | string | ' ' | name value for the input |
|
25 | | placeholder | string | | placeholder text for the input box |
|
26 | | required | bool | false | Makes the text input required |
|
27 | | description | string | | Help text for the input field |
|
28 |
|
29 | ### Example
|
30 | ```jsx
|
31 | <Input name="inputName" placeholder="Input Text Here" label="Awesome Label" />
|
32 | ```
|