@s-ui/react-molecule-textarea-field
Version:
`MoleculeTextareaField` is a component that wraps a composition of Label + Textarea + Validation Messages.
108 lines (86 loc) • 3.08 kB
Markdown
# MoleculeTextareaField
`MoleculeTextareaField` is a component that wraps a composition of Label + Textarea + Validation Messages.
[](https://sui-components.vercel.app/workbench/molecule/textareaField/)
[](https://github.com/SUI-Components/sui-components/issues/new?&projects=4&template=bug-report.yml&assignees=&template=report-a-bug.yml&title=🪲+&labels=bug,component,molecule,textareaField)
[](https://www.npmjs.com/package/@s-ui/react-molecule-textarea-field)
[](https://github.com/SUI-Components/sui-components/issues?q=is%3Aopen+label%3Acomponent+label%3AtextareaField)
[](https://github.com/SUI-Components/sui-components/blob/main/components/molecule/textareaField/LICENSE.md)
## Installation
```sh
$ npm install @s-ui/react-molecule-textarea-field --save
```
## Usage
After importing the component `MoleculeTextareaField` like this
```javascript
import MoleculeTextareaField from '@s-ui/react-molecule-textarea-field'
```
### Basic usage
```
<MoleculeTextareaField
id="description"
label="Description"
/>
```
### With initial value
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
/>
```
### With maxChars
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
maxChars={75}
/>
```
### With Error Message
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
errorText="All wrong!"
/>
```
### With Success Message
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
successText="Everything ok!"
/>
```
### With Alert Message
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
alertText="Ok, but's something needs your attention..."
/>
```
### With Help Text
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
helpText="Enter some description with no less than 20 characters"
/>
```
### Inline
```
<MoleculeTextareaField
id="description"
label="Description"
value="In some place of La Mancha which name..."
inline
/>
```
> **Find full description and more examples in the [demo page](https://sui-components.now.sh/workbench/molecule/textareaField/demo).**