Textarea
<sl-textarea> | SlTextarea
Textareas collect data from the user and allow multiple lines of text.
Examples
Basic Textarea with Label
Use the label attribute to give the textarea an accessible label.
<sl-textarea label="Month in review"></sl-textarea>
sl-textarea label="Month in review"
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea />;
This component works with standard <form> elements. Please refer to the section on
form controls to learn more about form submission and
client-side validation.
Help Text
Add descriptive help text to a textarea with the help-text attribute. For help text that
contains HTML, use the help-text slot instead.
<sl-textarea label="Month in review" help-text="Tell us the highlights. Be sure to include details about any financial performance anomalies."> </sl-textarea> <br /> <sl-textarea label="Month in review"> <div slot="help-text">Tell us the highlights. Be sure to include details about any financial performance <strong>anomalies</strong>.</div> </sl-textarea>
sl-textarea label="Month in review" help-text="Tell us the highlights. Be sure to include details about any financial performance anomalies." br sl-textarea label="Month in review" div slot="help-text" | Tell us the highlights. Be sure to include details about any financial performance strong anomalies | .
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea label="Feedback" help-text="Please tell us what you think." />;
Label with Tooltip
Use the label-tooltip attribute to add text that appears in a tooltip triggered by an info icon
next to the label.
Usage: Use the label tooltip to provide helpful but non-essential instructions or examples to guide the user when filling in the textarea. Use help text to communicate instructions or requirements for filling in the textarea without errors.
<sl-textarea label="Month in review" help-text="Tell us the highlights. Be sure to include details about any financial performance anomalies." label-tooltip="There is no required format for this commentary. However, we suggest covering the following topics: 1) Revenue, 2) COGS, 3) Gross profit, and 4) Operating expenses."></sl-textarea>
sl-textarea[label="Month in review" help-text="Tell us the highlights. Be sure to include details about any financial performance anomalies." label-tooltip="There is no required format for this commentary. However, we suggest covering the following topics: 1) Revenue, 2) COGS, 3) Gross profit, and 4) Operating expenses."]
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea label="Comments" />;
Label with Context Note
Use the context-note attribute to add text that provides additional context or reference. For
text that contains HTML, use the context-note slot. Note: On small screens the
context note will wrap below the label if there isn’t enough room next to the label.
Usage: Use a context note to provide secondary contextual data, especially dynamic data, that would help the user when filling in the textarea. Use help text to communicate instructions or requirements for filling in the textarea without errors.
<sl-textarea label="Month in review" help-text="Tell us the highlights. Be sure to include details about any financial performance anomalies." context-note="Data synced 1 hr ago"></sl-textarea>
sl-textarea[label="Month in review" help-text="Tell us the highlights. Be sure to include details about any financial performance anomalies." context-note="Data synced 1 hr ago"]
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea label="Comments" />;
Rows
Use the rows attribute to change the number of text rows that the textarea shows before the
text starts to overflow and the textarea scrolls.
<sl-textarea label="Textarea with 2 rows" rows="2"></sl-textarea> <br /> <sl-textarea label="Textarea with 4 rows (Default)" rows="4"></sl-textarea> <br /> <sl-textarea label="Textarea with 6 rows" rows="6"></sl-textarea>
sl-textarea label="Textarea with 2 rows" rows="2" br sl-textarea label="Textarea with 4 rows (Default)" rows="4" br sl-textarea label="Textarea with 6 rows" rows="6"
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea rows={2} />;
Disabled
Use the disabled attribute to disable a textarea.
<sl-textarea label="Disabled textarea" disabled></sl-textarea>
sl-textarea label="Disabled textarea" disabled="true"
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea placeholder="Textarea" disabled />;
Prevent Resizing
By default, textareas can be resized vertically by the user. To prevent resizing, set the
resize attribute to none.
<sl-textarea label="Textarea with no resizing" resize="none"></sl-textarea>
sl-textarea label="Textarea with no resizing" resize="none"
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea resize="none" />;
Expand with Content
Textareas will automatically resize to expand to fit their content when resize is set to
auto.
<sl-textarea label="Expanding textarea" resize="auto" value="Someone’s sitting in the shade today because someone planted a tree a long time ago. ... Keep typing to see the textarea expand..." rows="2"></sl-textarea>
sl-textarea label="Expanding textarea" resize="auto" value="Someone’s sitting in the shade today because someone planted a tree a long time ago. ... Keep typing to see the textarea expand..." rows="2"
import SlTextarea from '@teamshares/shoelace/dist/react/textarea'; const App = () => <SlTextarea resize="auto" />;
Usage guidelines
- For additional guidelines on textarea labels, help text, label tooltip, context note, and placeholder text, refer to the Input component usage guidelines
Importing
If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.
To import this component from the CDN using a script tag:
<script type="module" src="https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.1.0/cdn/components/textarea/textarea.js"></script>
To import this component from the CDN using a JavaScript import:
import 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.1.0/cdn/components/textarea/textarea.js';
To import this component using a bundler:
import '@shoelace-style/shoelace/dist/components/textarea/textarea.js';
To import this component as a React component:
import SlTextarea from '@shoelace-style/shoelace/dist/react/textarea';
Slots
| Name | Description |
|---|---|
label
|
The textarea’s label. Alternatively, you can use the label attribute. |
label-tooltip
|
Used to add text that is displayed in a tooltip next to the label. Alternatively, you can use the
label-tooltip attribute.
|
context-note
|
Used to add contextual text that is displayed above the textarea, on the right. Alternatively, you
can use the context-note attribute.
|
help-text
|
Text that describes how to use the input. Alternatively, you can use the
help-text attribute.
|
Learn more about using slots.
Properties
Note: The following appear as options in the Properties table but are currently not part of the Teamshares Design System. Please check with the design team before using these options:
- Sizes
small,large - Boolean
filled
Scroll right to see the entire table
| Name | Description | Reflects | Type | Default |
|---|---|---|---|---|
name
|
The name of the textarea, submitted as a name/value pair with form data. |
string
|
''
|
|
value
|
The current value of the textarea, submitted as a name/value pair with form data. |
string
|
''
|
|
size
|
The textarea’s size. |
|
'small' | 'medium' | 'large'
|
'medium'
|
filled
|
Draws a filled textarea. |
|
boolean
|
false
|
label
|
The textarea’s label. If you need to display HTML, use the label slot instead. |
string
|
''
|
|
labelTooltip
label-tooltip
|
Text that appears in a tooltip next to the label. If you need to display HTML in the tooltip, use
the label-tooltip slot instead.
|
string
|
''
|
|
contextNote
context-note
|
Text that appears above the textarea, on the right, to add additional context. If you need to
display HTML in this text, use the context-note slot instead.
|
string
|
''
|
|
helpText
help-text
|
The textarea’s help text. If you need to display HTML, use the help-text slot instead.
|
string
|
''
|
|
placeholder
|
Placeholder text to show as a hint when the input is empty. |
string
|
''
|
|
rows
|
The number of rows to display by default. |
number
|
4
|
|
resize
|
Controls how the textarea can be resized. |
'none' | 'vertical' | 'auto'
|
'vertical'
|
|
disabled
|
Disables the textarea. |
|
boolean
|
false
|
readonly
|
Makes the textarea readonly. |
|
boolean
|
false
|
form
|
By default, form controls are associated with the nearest containing
<form> element. This attribute allows you to place the form control outside of a
form and associate it with the form that has this id. The form must be in the same
document or shadow root for this to work.
|
|
string
|
''
|
required
|
Makes the textarea a required field. |
|
boolean
|
false
|
minlength
|
The minimum length of input that will be considered valid. |
number
|
- | |
maxlength
|
The maximum length of input that will be considered valid. |
number
|
- | |
autocapitalize
|
Controls whether and how text input is automatically capitalized as it is entered by the user. |
'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'
|
- | |
autocorrect
|
Indicates whether the browser’s autocorrect feature is on or off. |
string
|
- | |
autocomplete
|
Specifies what permission the browser has to provide assistance in filling out form field values. Refer to this page on MDN for available values. |
string
|
- | |
autofocus
|
Indicates that the input should receive focus on page load. |
boolean
|
- | |
enterkeyhint
|
Used to customize the label or icon of the Enter key on virtual keyboards. |
'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'
|
- | |
spellcheck
|
Enables spell checking on the textarea. |
boolean
|
true
|
|
inputmode
|
Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual keyboard on supportive devices. |
'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'
|
- | |
defaultValue
|
The default value of the form control. Primarily used for resetting the form control. |
string
|
''
|
|
validity
|
Gets the validity state object | - | - | |
validationMessage
|
Gets the validation message | - | - | |
updateComplete
|
A read-only promise that resolves when the component has finished updating. |
Learn more about attributes and properties.
Events
| Name | React Event | Description | Event Detail |
|---|---|---|---|
sl-blur
|
onSlBlur
|
Emitted when the control loses focus. | - |
sl-change
|
onSlChange
|
Emitted when an alteration to the control’s value is committed by the user. | - |
sl-focus
|
onSlFocus
|
Emitted when the control gains focus. | - |
sl-input
|
onSlInput
|
Emitted when the control receives input. | - |
sl-invalid
|
onSlInvalid
|
Emitted when the form control has been checked for validity and its constraints aren’t satisfied. | - |
Learn more about events.
Methods
| Name | Description | Arguments |
|---|---|---|
focus()
|
Sets focus on the textarea. |
options: FocusOptions
|
blur()
|
Removes focus from the textarea. | - |
select()
|
Selects all the text in the textarea. | - |
scrollPosition()
|
Gets or sets the textarea’s scroll position. |
position: { top?: number; left?: number }
|
setSelectionRange()
|
Sets the start and end positions of the text selection (0-based). |
selectionStart: number , selectionEnd: number , selectionDirection: 'forward' | 'backward' |
'none'
|
setRangeText()
|
Replaces a range of text with a new string. |
replacement: string , start: number , end: number , selectMode: 'select' | 'start' | 'end' |
'preserve'
|
checkValidity()
|
Checks for validity but does not show a validation message. Returns true when valid and
false when invalid.
|
- |
getForm()
|
Gets the associated form, if one exists. | - |
reportValidity()
|
Checks for validity and shows the browser’s validation message if the control is invalid. | - |
setCustomValidity()
|
Sets a custom validation message. Pass an empty string to restore validity. |
message: string
|
Learn more about methods.
Parts
| Name | Description |
|---|---|
form-control
|
The form control that wraps the label, input, and help text. |
form-control-label
|
The label’s wrapper. |
form-control-input
|
The input’s wrapper. |
form-control-help-text
|
The help text’s wrapper. |
base
|
The component’s base wrapper. |
textarea
|
The internal <textarea> control. |
Learn more about customizing CSS parts.