2020-07-15 21:30:37 +00:00
|
|
|
# Textarea
|
|
|
|
|
|
|
|
|
|
[component-header:sl-textarea]
|
|
|
|
|
|
|
|
|
|
Textareas collect data from the user and allow multiple lines of text.
|
|
|
|
|
|
|
|
|
|
```html preview
|
|
|
|
|
<sl-textarea></sl-textarea>
|
|
|
|
|
```
|
|
|
|
|
|
2021-05-13 13:11:24 +00:00
|
|
|
?> This component doesn't work with standard forms. Use [`<sl-form>`](/components/form) instead.
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-08-28 20:14:39 +00:00
|
|
|
?> Please refer to the section on [form control validation](/components/form?id=form-control-validation) to learn how to do client-side validation.
|
|
|
|
|
|
2020-07-15 21:30:37 +00:00
|
|
|
## Examples
|
|
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
### Rows
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
Use the `rows` attribute to change the number of text rows that get shown.
|
2020-07-15 21:30:37 +00:00
|
|
|
|
|
|
|
|
```html preview
|
2020-08-25 20:23:33 +00:00
|
|
|
<sl-textarea rows="2"></sl-textarea>
|
2020-07-15 21:30:37 +00:00
|
|
|
```
|
|
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
### Placeholders
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
Use the `placeholder` attribute to add a placeholder.
|
2020-07-15 21:30:37 +00:00
|
|
|
|
|
|
|
|
```html preview
|
2020-08-25 20:23:33 +00:00
|
|
|
<sl-textarea placeholder="Type something"></sl-textarea>
|
2020-07-15 21:30:37 +00:00
|
|
|
```
|
|
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
### Disabled
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
Use the `disabled` attribute to disable an input.
|
2020-07-15 21:30:37 +00:00
|
|
|
|
|
|
|
|
```html preview
|
2020-08-25 20:23:33 +00:00
|
|
|
<sl-textarea placeholder="Textarea" disabled></sl-textarea>
|
2020-07-15 21:30:37 +00:00
|
|
|
```
|
|
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
### Sizes
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
Use the `size` attribute to change a textarea's size.
|
2020-07-15 21:30:37 +00:00
|
|
|
|
|
|
|
|
```html preview
|
2020-08-25 20:23:33 +00:00
|
|
|
<sl-textarea placeholder="Small" size="small"></sl-textarea>
|
|
|
|
|
<br>
|
|
|
|
|
<sl-textarea placeholder="Medium" size="medium"></sl-textarea>
|
|
|
|
|
<br>
|
|
|
|
|
<sl-textarea placeholder="Large" size="large"></sl-textarea>
|
2020-07-15 21:30:37 +00:00
|
|
|
```
|
|
|
|
|
|
2020-08-25 20:23:33 +00:00
|
|
|
### Labels
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-12-23 20:47:13 +00:00
|
|
|
Use the `label` attribute to give the textarea an accessible label. For labels that contain HTML, use the `label` slot instead.
|
2020-07-15 21:30:37 +00:00
|
|
|
|
|
|
|
|
```html preview
|
2020-08-25 20:23:33 +00:00
|
|
|
<sl-textarea label="Comments"></sl-textarea>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Help Text
|
|
|
|
|
|
2020-12-23 20:47:13 +00:00
|
|
|
Add descriptive help text to a textarea with the `help-text` attribute. For help texts that contain HTML, use the `help-text` slot instead.
|
2020-08-25 20:23:33 +00:00
|
|
|
|
|
|
|
|
```html preview
|
2020-12-23 20:47:13 +00:00
|
|
|
<sl-textarea
|
|
|
|
|
label="Feedback"
|
|
|
|
|
help-text="Please tell us what you think."
|
|
|
|
|
>
|
2020-08-25 20:23:33 +00:00
|
|
|
</sl-textarea>
|
2020-07-15 21:30:37 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Prevent Resizing
|
|
|
|
|
|
|
|
|
|
By default, textareas can be resized vertically by the user. To prevent resizing, set the `resize` attribute to `none`.
|
|
|
|
|
|
|
|
|
|
```html preview
|
|
|
|
|
<sl-textarea resize="none"></sl-textarea>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Expand with Content
|
|
|
|
|
|
|
|
|
|
Textareas will automatically resize to expand to fit their content when `resize` is set to `auto`.
|
|
|
|
|
|
|
|
|
|
```html preview
|
|
|
|
|
<sl-textarea resize="auto"></sl-textarea>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[component-metadata:sl-textarea]
|
