diff --git a/components/input/readme.md b/components/input/readme.md index fe4384ef..89b57575 100644 --- a/components/input/readme.md +++ b/components/input/readme.md @@ -7,7 +7,7 @@ Although we are calling them Inputs they actually correspond to Material Design import Input from 'react-toolbox/lib/input'; class InputTest extends React.Component { - state = { name: '', phone: '', email: '' }; + state = { name: '', phone: '', email: '', hint: '' }; handleChange = (name, value) => { this.setState({...this.state, [name]: value}); @@ -20,7 +20,7 @@ class InputTest extends React.Component { - J} /> + J} /> ); } @@ -29,24 +29,24 @@ class InputTest extends React.Component { ## Properties -| Name | Type | Default | Description| +| Name | Type | Default | Description| |:-----|:-----|:-----|:-----| -| `className` | `String` |`''` | Sets a class name to give custom styles.| -| `disabled` | `Boolean` | `false` | If true, component will be disabled.| -| `error` | `String` | | Give an error string to display under the field.| -| `hint` | `String` |`''` | The text string to use for hint text element.| -| `icon` | `String` | | Name of an icon to use as a label for the input.| -| `floating` | `Boolean` | `true` | Indicates if the label is floating in the input field or not.| -| `label` | `String` | | The text string to use for the floating label element.| -| `maxLength` | `number` | |Specifies the maximum number of characters allowed in the component.| -| `multiline` | `Boolean` | `false` | If true, a textarea element will be rendered. The textarea also grows and shrinks according to the number of lines.| -| `onBlur` | `Function` | | Callback function that is fired when components is blured.| -| `onChange` | `Function` | | Callback function that is fired when the components's value changes.| -| `onFocus` | `Function` | | Callback function that is fired when components is focused.| -| `onKeyPress` | `Function` | | Callback function that is fired when a key is pressed.| -| `required` | `Boolean` | `false` | If true, the html input has a required value.| -| `type` | `String` | `text` | Type of the input element. It can be a valid HTML5 input type| -| `value` | `String` | | Current value of the input element.| +| `className` | `String` | `''` | Sets a class name to give custom styles.| +| `disabled` | `Boolean` | `false` | If true, component will be disabled.| +| `error` | `Node` | | Give an error node to display under the field.| +| `floating` | `Boolean` | `true` | Indicates if the label is floating in the input field or not.| +| `hint` | `String` | `''` | The text string to use for hint text element.| +| `icon` | `Any` | | Name of an icon to use as a label for the input.| +| `label` | `String` | | The text string to use for the floating label element.| +| `maxLength` | `Number` | |Specifies the maximum number of characters allowed in the component.| +| `multiline` | `Boolean` | `false` | If true, a textarea element will be rendered. The textarea also grows and shrinks according to the number of lines.| +| `onBlur` | `Function` | | Callback function that is fired when component is blured.| +| `onChange` | `Function` | | Callback function that is fired when the component's value changes.| +| `onFocus` | `Function` | | Callback function that is fired when component is focused.| +| `onKeyPress` | `Function` | | Callback function that is fired when a key is pressed.| +| `required` | `Boolean` | `false` | If true, the html input has a required attribute.| +| `type` | `String` | `text` | Type of the input element. It can be a valid HTML5 input type| +| `value` | `Any` | | Current value of the input element.| ## Methods diff --git a/docs/app/components/layout/main/modules/examples/input_example_1.txt b/docs/app/components/layout/main/modules/examples/input_example_1.txt index 9043f00f..9cc017dc 100644 --- a/docs/app/components/layout/main/modules/examples/input_example_1.txt +++ b/docs/app/components/layout/main/modules/examples/input_example_1.txt @@ -1,5 +1,5 @@ class InputTest extends React.Component { - state = { name: '', phone: '', email: '' }; + state = { name: '', phone: '', email: '', hint: '' }; handleChange = (name, value) => { this.setState({...this.state, [name]: value}); @@ -12,6 +12,7 @@ class InputTest extends React.Component { + J} /> ); }