@kiwicom/orbit-components
Version:
<div align="center"> <a href="https://orbit.kiwi" target="_blank"> <img alt="orbit-components" src="https://orbit.kiwi/wp-content/uploads/2018/08/orbit-components.png" srcset="https://orbit.kiwi/wp-content/uploads/2018/08/orbit-components@2x.png 2x"
42 lines (35 loc) • 2.17 kB
Markdown
# Textarea
To implement Textarea component into your project you'll need to add the import:
```jsx
import Textarea from "@kiwicom/orbit-components/lib/Textarea";
```
After adding import into your project you can use it simply like:
```jsx
<Textarea />
```
## Props
Table below contains all types of the props available in Textarea component.
| Name | Type | Default | Description |
| :------------ | :---------------- | :----------- | :------------------------------- |
| dataTest | `string` | | Optional prop for testing purposes.
| disabled | `boolean` | | If `true`, the Textarea will be disabled.
| error | `React.Node` | | The error to display beneath the Textarea. [See Functional specs](#functional-specs)
| help | `React.Node` | | The help to display beneath the Textarea.
| label | `string` | | The label for the Textarea. [See Functional specs](#functional-specs)
| maxLength | `number` | | Specifies the maximum number of characters allowed.
| name | `string` | | The name for the Textarea.
| onChange | `func` | | Function for handling onClick event.
| onFocus | `func` | | Function for handling onFocus event.
| onBlur | `func` | | Function for handling onBlur event.
| placeholder | `string` | | The placeholder of the Textarea.
| resize | [`enum`](#enum) | `"vertical"` | The resize option for Textarea.
| size | [`enum`](#enum) | `"normal"` | The size of the Textarea.
| value | `string` | | Specifies the value of the Textarea.
### enum
| size | resize |
| :----------- | :------------ |
| `"small"` | `"vertical"`
| `"normal"` | `"none"`
## Functional specs
* The `error` prop overwrites the `help` prop, due to higher priority.
* The color of the label will turn into cloud shade when the Textarea has some filled value.