| 1 | # zooid-input
|
| 2 | A React component to render Zooid like text inputs.
|
| 3 |
|
| 4 | ### Install
|
| 5 | ```
|
| 6 | npm install --save zooid-input
|
| 7 | ```
|
| 8 | ### Props
|
| 9 | | Prop | Type | Default | Description |
|
| 10 | | ----------- | -------| --------| -------------------------------------|
|
| 11 | | className | string | | Additional css classes for your input|
|
| 12 | | disabled | bool | false | Disables the text input |
|
| 13 | | label | string | | The label for the text input |
|
| 14 | | name | string | ' ' | name value for the input |
|
| 15 | | placeholder | string | | placeholder text for the input box |
|
| 16 | | required | bool | false | Makes the text input required |
|
| 17 | | description | string | | Help text for the input field |
|
| 18 |
|
| 19 | ### Example
|
| 20 | ```jsx
|
| 21 | <Input name="inputName" placeholder="Input Text Here" label="Awesome Label" />
|
| 22 | ```
|