UNPKG

@kiwicom/orbit-components

Version:

Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com’s products.

67 lines (55 loc) 2.84 kB
# 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) | fullHeight | `boolean` | `false` | If `true`, the Textarea will take 100 % of parent's height. | 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. | ref | `func` | | Prop for forwarded ref of the Textarea. [See Functional specs](#functional-specs) | 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. * `ref` can be used for example auto-focus the elements immediately after render. ```jsx class Component extends React.PureComponent<Props> { constructor() { super() this.ref = React.createRef(); } componentDidMount() { this.ref.current && this.ref.current.focus(); } ref: { current: React$ElementRef<*> | null }; render() { return ( <Textarea ref={this.ref} /> ) } } ```