textarea

Examples

API

Attributes and Properties #

Property	Attribute	Type	Default	Description
`allowedKeys`	`allowed-keys`	`string`	`''`
`autocomplete`	`autocomplete`	`\| HTMLInputElement['autocomplete'] \| HTMLTextAreaElement['autocomplete'] \| undefined`
`autofocus`	`autofocus`	`boolean`	`false`	When this control is rendered, focus it automatically
`dir`	`dir`	`'ltr' \| 'rtl'`	`'ltr'`
`disabled`	`disabled`	`boolean`	`false`	Disable this control. It will not receive focus or events
`focused`	`focused`	`boolean`	`false`
`grows`	`grows`	`boolean`	`false`
`invalid`	`invalid`	`boolean`	`false`
`label`	`label`	`string`	`''`
`maxlength`	`maxlength`	`number`	`-1`
`minlength`	`minlength`	`number`	`-1`
`multiline`	`multiline`	`boolean`	`false`
`pattern`	`pattern`	`string \| undefined`
`placeholder`	`placeholder`	`string`	`''`
`quiet`	`quiet`	`boolean`	`false`
`readonly`	`readonly`	`boolean`	`false`
`required`	`required`	`boolean`	`false`
`tabIndex`	`tabIndex`	`number`		The tab index to apply to this control. See general documentation about the tabindex HTML property
`_type`	`type`	`TextfieldType`	`'text'`
`valid`	`valid`	`boolean`	`false`
`value`	`value`	`string \| number`

Slots #

Name	Description
`help-text`	default or non-negative help text to associate to your form element
`negative-help-text`	negative help text to associate to your form element when `invalid`

Events #

Name	Type	Description
`change`	`Event`	`An alteration to the value of the element has been committed by the user.`
`input`	`Event`	`The value of the element has changed.`

CSS Custom Properties #

Name	Default
`--spectrum-alias-body-text-font-family`	`var(--spectrum-global-font-family-base)`
`--spectrum-alias-input-quiet-focusline-gap`	`var(--spectrum-global-dimension-static-size-10)`
`--spectrum-alias-single-line-width`	`var(--spectrum-global-dimension-size-2400)`
`--spectrum-alias-workflow-icon-size-m`	`var(--spectrum-global-dimension-size-225)`
`--spectrum-textarea-m-height`	`var(--spectrum-global-dimension-size-400)`
`--spectrum-textarea-m-padding-left`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textarea-m-padding-right`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textarea-m-text-padding-bottom`	`var(--spectrum-global-dimension-size-115)`
`--spectrum-textarea-m-text-padding-top`	`var(--spectrum-global-dimension-size-75)`
`--spectrum-textfield-m-quiet-texticon-background-color`	`var(--spectrum-alias-background-color-transparent)`
`--spectrum-textfield-m-quiet-texticon-background-color-disabled`	`var(--spectrum-alias-background-color-transparent)`
`--spectrum-textfield-m-quiet-texticon-border-bottom-size`	`var(--spectrum-alias-input-border-size)`
`--spectrum-textfield-m-quiet-texticon-border-color`	`var(--spectrum-alias-input-border-color-default)`
`--spectrum-textfield-m-quiet-texticon-border-color-disabled`	`var(--spectrum-alias-input-border-color-quiet-disabled)`
`--spectrum-textfield-m-quiet-texticon-border-color-down`	`var(--spectrum-alias-input-border-color-down)`
`--spectrum-textfield-m-quiet-texticon-border-color-hover`	`var(--spectrum-alias-input-border-color-hover)`
`--spectrum-textfield-m-quiet-texticon-border-color-invalid`	`var(--spectrum-alias-input-border-color-invalid-default)`
`--spectrum-textfield-m-quiet-texticon-border-color-invalid-key-focus`	`var(--spectrum-alias-input-border-color-invalid-key-focus)`
`--spectrum-textfield-m-quiet-texticon-border-color-invalid-mouse-focus`	`var(--spectrum-alias-input-border-color-invalid-mouse-focus)`
`--spectrum-textfield-m-quiet-texticon-border-color-mouse-focus`	`var(--spectrum-alias-input-border-color-mouse-focus)`
`--spectrum-textfield-m-quiet-texticon-border-radius`	`var(--spectrum-global-dimension-size-0)`
`--spectrum-textfield-m-quiet-texticon-invalid-icon-margin-left`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textfield-m-quiet-texticon-padding-left`	`var(--spectrum-global-dimension-size-0)`
`--spectrum-textfield-m-quiet-texticon-padding-right`	`var(--spectrum-global-dimension-size-0)`
`--spectrum-textfield-m-quiet-texticon-success-icon-margin-left`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textfield-m-texticon-background-color`	`var(--spectrum-global-color-gray-50)`
`--spectrum-textfield-m-texticon-background-color-disabled`	`var(--spectrum-global-color-gray-200)`
`--spectrum-textfield-m-texticon-border-color`	`var(--spectrum-alias-input-border-color-default)`
`--spectrum-textfield-m-texticon-border-color-disabled`	`var(--spectrum-alias-input-border-color-disabled)`
`--spectrum-textfield-m-texticon-border-color-down`	`var(--spectrum-alias-input-border-color-down)`
`--spectrum-textfield-m-texticon-border-color-hover`	`var(--spectrum-alias-input-border-color-hover)`
`--spectrum-textfield-m-texticon-border-color-invalid`	`var(--spectrum-alias-input-border-color-invalid-default)`
`--spectrum-textfield-m-texticon-border-color-invalid-hover`	`var(--spectrum-alias-input-border-color-invalid-hover)`
`--spectrum-textfield-m-texticon-border-color-invalid-key-focus`	`var(--spectrum-alias-input-border-color-invalid-key-focus)`
`--spectrum-textfield-m-texticon-border-color-invalid-mouse-focus`	`var(--spectrum-alias-input-border-color-invalid-mouse-focus)`
`--spectrum-textfield-m-texticon-border-color-key-focus`	`var(--spectrum-alias-input-border-color-key-focus)`
`--spectrum-textfield-m-texticon-border-radius`	`var(--spectrum-alias-border-radius-regular)`
`--spectrum-textfield-m-texticon-border-size`	`var(--spectrum-alias-input-border-size)`
`--spectrum-textfield-m-texticon-focus-ring-border-width`	`var(--spectrum-alias-component-focusring-size)`
`--spectrum-textfield-m-texticon-focus-ring-gap`	`var(--spectrum-alias-input-focusring-gap)`
`--spectrum-textfield-m-texticon-height`	`var(--spectrum-global-dimension-size-400)`
`--spectrum-textfield-m-texticon-icon-color`	`var(--spectrum-alias-component-icon-color-default)`
`--spectrum-textfield-m-texticon-icon-color-disabled`	`var(--spectrum-alias-component-icon-color-disabled)`
`--spectrum-textfield-m-texticon-icon-color-down`	`var(--spectrum-alias-component-icon-color-down)`
`--spectrum-textfield-m-texticon-icon-color-hover`	`var(--spectrum-alias-component-icon-color-hover)`
`--spectrum-textfield-m-texticon-invalid-icon-height`	`var(--spectrum-alias-ui-icon-alert-size-100)`
`--spectrum-textfield-m-texticon-invalid-icon-margin-left`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textfield-m-texticon-invalid-icon-width`	`var(--spectrum-alias-ui-icon-alert-size-100)`
`--spectrum-textfield-m-texticon-min-width`	`var(--spectrum-global-dimension-size-600)`
`--spectrum-textfield-m-texticon-padding-left`	`undefined`
`--spectrum-textfield-m-texticon-padding-right`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textfield-m-texticon-placeholder-text-color`	`var(--spectrum-global-color-gray-600)`
`--spectrum-textfield-m-texticon-placeholder-text-color-disabled`	`var(--spectrum-alias-text-color-disabled)`
`--spectrum-textfield-m-texticon-placeholder-text-color-hover`	`var(--spectrum-alias-placeholder-text-color-hover)`
`--spectrum-textfield-m-texticon-placeholder-text-font-style`	`var(--spectrum-global-font-style-italic)`
`--spectrum-textfield-m-texticon-placeholder-text-font-weight`	`var(--spectrum-global-font-weight-regular)`
`--spectrum-textfield-m-texticon-success-icon-height`	`var(--spectrum-alias-ui-icon-checkmark-size-100)`
`--spectrum-textfield-m-texticon-success-icon-margin-left`	`var(--spectrum-global-dimension-size-150)`
`--spectrum-textfield-m-texticon-success-icon-width`	`var(--spectrum-alias-ui-icon-checkmark-size-100)`
`--spectrum-textfield-m-texticon-text-color`	`var(--spectrum-alias-component-text-color-default)`
`--spectrum-textfield-m-texticon-text-color-disabled`	`var(--spectrum-alias-component-text-color-disabled)`
`--spectrum-textfield-m-texticon-text-line-height`	`var(--spectrum-alias-component-text-line-height)`
`--spectrum-textfield-m-texticon-text-size`	`var(--spectrum-global-dimension-font-size-100)`
`--spectrum-textfield-m-texticon-validation-icon-color-invalid`	`var(--spectrum-semantic-negative-icon-color)`
`--spectrum-textfield-m-texticon-validation-icon-color-invalid-disabled`	`var(--spectrum-alias-background-color-transparent)`
`--spectrum-textfield-m-texticon-validation-icon-color-valid`	`var(--spectrum-semantic-positive-icon-color)`
`--spectrum-textfield-m-textonly-focus-ring-border-color-key-focus`	`var(--spectrum-alias-focus-ring-color)`

Description #

sp-textfield[multiline] components are text areas that allow users to input custom multiline text entries with a keyboard. Various decorations can be displayed around the field to communicate the entry requirements.

Usage #

yarn add @spectrum-web-components/textfield

Import the side effectful registration of <sp-textfield> via:

import '@spectrum-web-components/textfield/sp-textfield.js';

When looking to leverage the Textfield base class as a type and/or for extension purposes, do so via:

import { Textfield } from '@spectrum-web-components/textfield';

Example #

<sp-field-label for="story-0">Background</sp-field-label>
<sp-textfield
    id="story-0"
    multiline
    placeholder="Enter your life story"
></sp-textfield>

Variants #

Valid #

Dictate the validity state of the text entry with the valid attribute.

<sp-field-label for="story-1" required>Background</sp-field-label>
<sp-textfield
    id="story-1"
    multiline
    placeholder="Enter your name"
    valid
></sp-textfield>

Invalid #

Dictate the invalidity state of the text entry with the invalid attribute.

<sp-field-label for="story-2" required>Background</sp-field-label>
<sp-textfield
    id="story-2"
    invalid
    multiline
    placeholder="Enter your name"
></sp-textfield>

Quiet #

The quiet style works best when a clear layout (vertical stack, table, grid) assists in a user's ability to parse the element. Too many quiet components in a small space can be hard to read.

<sp-field-label for="story-3">Background (quietly)</sp-field-label>
<sp-textfield
    id="story-3"
    multiline
    placeholder="Enter your name"
    quiet
></sp-textfield>

Grows #

By default the text area has a fixed height and will scroll when text entry goes beyond the available space. With the use of the grows attribute the text area will grow to accomidate the full content of the element.

Note: When leveraging the quiet attribute, the grows attribute does not effect the final delivery of the element.

<div style="display: flex; flex-wrap: wrap;">
    <div>
        <sp-field-label for="story-4">Background</sp-field-label>
        <sp-textfield
            id="story-4"
            multiline
            placeholder="Enter your name"
            value="By default the text area has a fixed height and will scroll when text entry goes beyond the available space. With the use of the `grows` attribute the text area will grow to accomidate the full content of the element."
        ></sp-textfield>
    </div>
    <div>
        <sp-field-label for="story-5">Background</sp-field-label>
        <sp-textfield
            id="story-5"
            grows
            multiline
            placeholder="Enter your name"
            value="By default the text area has a fixed height and will scroll when text entry goes beyond the available space. With the use of the `grows` attribute the text area will grow to accomidate the full content of the element."
        ></sp-textfield>
    </div>
    <div>
        <sp-field-label for="story-6">Background (quietly)</sp-field-label>
        <sp-textfield
            id="story-6"
            grows
            multiline
            placeholder="Enter your name"
            value="By default the text area has a fixed height and will scroll when text entry goes beyond the available space. With the use of the `grows` attribute the text area will grow to accomidate the full content of the element."
            quiet
        ></sp-textfield>
    </div>
</div>

Help text #

Help text can be accessibly associated with an <sp-textfield multiline> element by using the help-text or negative-help-text slots. When using the negative-help-text slot, <sp-textfield multiline> will self manage the presence of this content based on the value of the invalid property on your <sp-textfield multiline> element. Content within the help-text slot will be show by default. When your <sp-textfield multiline> should receive help text based on state outside of the complexity of invalid or not, manage the content addressed to the help-text from above to ensure that it displays the right messaging and possesses the right variant.

Self managed

<sp-field-label for="self">Stay "Positive"</sp-field-label>
<sp-textfield
    multiline
    id="self"
    pattern="[P][o][s][i][t][i][v][e]"
    value="Positive"
>
    <sp-help-text slot="help-text">
        Tell us how you are feeling today.
    </sp-help-text>
    <sp-help-text slot="negative-help-text">Please be "Positive".</sp-help-text>
</sp-textfield>

Managed from above

<sp-field-label for="managed">Stay "Positive"</sp-field-label>
<sp-textfield
    multiline
    id="managed"
    pattern="[P][o][s][i][t][i][v][e]"
    value="Positive"
    oninput='
        const helpText = this.querySelector(`[slot="help-text"]`);
        helpText.textContent = this.invalid ? `Please be "Positive".` : `Tell us how you are feeling today.`;
        helpText.variant = this.invalid ? `negative` : `neutral`;
    '
>
    <sp-help-text slot="help-text">
        Tell us how you're feeling today.
    </sp-help-text>
</sp-textfield>

Spectrum Web Components