Text Area Styling

Styling API reference for the Text Area component.

Style Variants
Style Properties
CSS Selectors

Style Variants

The following style variants can be applied:

Variant Description Supported by

Variant	Description	Supported by
`align-left`	Aligns the text to the left side of the field (default)	Aura, Lumo
`align-center`	Centers the text within the field	Lumo
`align-right`	Aligns the text to the right side of the field. Recommended for numerical values when presented in vertical groups.	Aura, Lumo
`align-start`	Aligns the text to the start side of the field, taking into account the current text direction (left for LTR, right for RTL)	Aura
`align-end`	Aligns the text to the end side of the field, taking into account the current text direction (right for LTR, left for RTL)	Aura
`small`	Renders a more compact field	Lumo
`helper-above-field`	Renders the helper above the field, and below the label	Aura, Lumo

align-left

Aligns the text to the left side of the field (default)

Aura, Lumo

align-center

Centers the text within the field

Lumo

align-right

Aligns the text to the right side of the field. Recommended for numerical values when presented in vertical groups.

Aura, Lumo

align-start

Aligns the text to the start side of the field, taking into account the current text direction (left for LTR, right for RTL)

Aura

align-end

Aligns the text to the end side of the field, taking into account the current text direction (right for LTR, left for RTL)

Aura

small

Renders a more compact field

Lumo

helper-above-field

Renders the helper above the field, and below the label

Aura, Lumo

Open in a
new tab

Source code

TextAreaStyles.javapackage com.vaadin.demo.component.textarea;

import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
import com.vaadin.flow.component.textfield.TextArea;
import com.vaadin.flow.component.textfield.TextAreaVariant;
import com.vaadin.flow.router.Route;

@Route("text-area-styles")
public class TextAreaStyles extends HorizontalLayout {

    public TextAreaStyles() {
        setPadding(false);

        // tag::snippet[]
        TextArea field = new TextArea();
        field.addThemeVariants(TextAreaVariant.LUMO_SMALL,
                TextAreaVariant.LUMO_ALIGN_RIGHT,
                TextAreaVariant.LUMO_HELPER_ABOVE_FIELD);
        // end::snippet[]
        field.setLabel("Label");
        field.setHelperText("Helper text");
        field.setValue("Value");
        field.setWidthFull();

        add(field);
    }

}
text-area-styles.tsximport React from 'react';
import { TextArea } from '@vaadin/react-components/TextArea.js';

function Example() {
  return (
    // tag::snippet[]
    <TextArea
      theme="align-right small helper-above-field"
      label="Label"
      helperText="Helper text"
      value="Value"
      style={{ width: '100%' }}
    />
    // end::snippet[]
  );
}

text-area-styles.tsimport '@vaadin/text-area';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
import { applyTheme } from 'Frontend/demo/theme';

@customElement('text-area-styles')
export class Example extends LitElement {
  protected override createRenderRoot() {
    const root = super.createRenderRoot();
    applyTheme(root);
    return root;
  }

  protected override render() {
    return html`
      <!-- tag::snippet[] -->
      <vaadin-text-area
        theme="align-right small helper-above-field"
        label="Label"
        helper-text="Helper text"
        value="Value"
        style="width: 100%;"
      ></vaadin-text-area>
      <!-- end::snippet[] -->
    `;
  }
}

Style Properties

The following style properties can be used in CSS stylesheets to customize the appearance of this component.

To apply values to these properties globally in your application UI, place them in a CSS block using the html {…} selector. See Component Style Properties for more information on style properties.

Note	Input Field Components Shared Styles Style properties whose names start with `--vaadin-input-field` are shared among all input field components. To apply them only to a specific type of component, use an element selector like `vaadin-text-field {…}`

Field Surface

Common Properties

Property Supported by

Property	Supported by
`--vaadin-input-field-background`	Aura, Lumo
`--vaadin-input-field-border-color`	Aura, Lumo
`--vaadin-input-field-border-radius`	Aura, Lumo
`--vaadin-input-field-border-width`	Aura, Lumo
`--vaadin-input-field-bottom-end-radius`	Aura, Lumo
`--vaadin-input-field-bottom-start-radius`	Aura, Lumo
`--vaadin-input-field-container-gap`	Aura
`--vaadin-input-field-height`	Lumo
`--vaadin-input-field-padding`	Aura
`--vaadin-input-field-placeholder-color`	Aura, Lumo
`--vaadin-input-field-top-start-radius`	Aura, Lumo
`--vaadin-input-field-top-end-radius`	Aura, Lumo
`--vaadin-input-field-value-color`	Aura, Lumo
`--vaadin-input-field-value-font-size`	Aura, Lumo
`--vaadin-input-field-value-font-weight`	Aura, Lumo
`--vaadin-input-field-value-line-height`	Aura, Lumo

--vaadin-input-field-background

Aura, Lumo

--vaadin-input-field-border-color

Aura, Lumo

--vaadin-input-field-border-radius

Aura, Lumo

--vaadin-input-field-border-width

Aura, Lumo

--vaadin-input-field-bottom-end-radius

Aura, Lumo

--vaadin-input-field-bottom-start-radius

Aura, Lumo

--vaadin-input-field-container-gap

Aura

--vaadin-input-field-height

Lumo

--vaadin-input-field-padding

Aura

--vaadin-input-field-placeholder-color

Aura, Lumo

--vaadin-input-field-top-start-radius

Aura, Lumo

--vaadin-input-field-top-end-radius

Aura, Lumo

--vaadin-input-field-value-color

Aura, Lumo

--vaadin-input-field-value-font-size

Aura, Lumo

--vaadin-input-field-value-font-weight

Aura, Lumo

--vaadin-input-field-value-line-height

Aura, Lumo

Field States

Property Supported by

Property	Supported by
`--vaadin-focus-ring-width`	Aura, Lumo
`--vaadin-focus-ring-color`	Aura, Lumo
`--vaadin-input-field-disabled-background`	Aura, Lumo
`--vaadin-input-field-disabled-value-color`	Lumo
`--vaadin-input-field-hover-highlight`	Lumo
`--vaadin-input-field-hover-highlight-opacity`	Lumo
`--vaadin-input-field-invalid-background`	Lumo
`--vaadin-input-field-invalid-hover-highlight`	Lumo
`--vaadin-input-field-readonly-border`	Lumo

--vaadin-focus-ring-width

Aura, Lumo

--vaadin-focus-ring-color

Aura, Lumo

--vaadin-input-field-disabled-background

Aura, Lumo

--vaadin-input-field-disabled-value-color

Lumo

--vaadin-input-field-hover-highlight

Lumo

--vaadin-input-field-hover-highlight-opacity

Lumo

--vaadin-input-field-invalid-background

Lumo

--vaadin-input-field-invalid-hover-highlight

Lumo

--vaadin-input-field-readonly-border

Lumo

Label

Property Supported by

Property	Supported by
`--vaadin-input-field-focused-label-color`	Lumo
`--vaadin-input-field-hovered-label-color`	Lumo
`--vaadin-input-field-label-color`	Aura, Lumo
`--vaadin-input-field-label-font-size`	Aura, Lumo
`--vaadin-input-field-label-font-weight`	Aura, Lumo
`--vaadin-input-field-label-line-height`	Aura, Lumo
`--vaadin-input-field-required-indicator-color`	Aura, Lumo
`--vaadin-input-field-required-indicator`	Aura, Lumo

--vaadin-input-field-focused-label-color

Lumo

--vaadin-input-field-hovered-label-color

Lumo

--vaadin-input-field-label-color

Aura, Lumo

--vaadin-input-field-label-font-size

Aura, Lumo

--vaadin-input-field-label-font-weight

Aura, Lumo

--vaadin-input-field-label-line-height

Aura, Lumo

--vaadin-input-field-required-indicator-color

Aura, Lumo

--vaadin-input-field-required-indicator

Aura, Lumo

Helper

Property Supported by

Property	Supported by
`--vaadin-input-field-helper-color`	Aura, Lumo
`--vaadin-input-field-helper-font-size`	Aura, Lumo
`--vaadin-input-field-helper-font-weight`	Aura, Lumo
`--vaadin-input-field-helper-line-height`	Aura, Lumo
`--vaadin-input-field-helper-spacing`	Lumo

--vaadin-input-field-helper-color

Aura, Lumo

--vaadin-input-field-helper-font-size

Aura, Lumo

--vaadin-input-field-helper-font-weight

Aura, Lumo

--vaadin-input-field-helper-line-height

Aura, Lumo

--vaadin-input-field-helper-spacing

Lumo

Error Message

Property Supported by

Property	Supported by
`--vaadin-input-field-error-color`	Aura, Lumo
`--vaadin-input-field-error-font-size`	Aura, Lumo
`--vaadin-input-field-error-font-weight`	Aura, Lumo
`--vaadin-input-field-error-line-height`	Aura, Lumo

--vaadin-input-field-error-color

Aura, Lumo

--vaadin-input-field-error-font-size

Aura, Lumo

--vaadin-input-field-error-font-weight

Aura, Lumo

--vaadin-input-field-error-line-height

Aura, Lumo

Field Buttons

Property Supported by

Property	Supported by
`--vaadin-clickable-cursor`	Aura
`--vaadin-disabled-cursor`	Aura
`--vaadin-icon-size`	Aura
`--vaadin-icon-visual-size`	Aura
`--vaadin-input-field-button-text-color`	Aura
`--vaadin-input-field-icon-size`	Lumo
`--vaadin-input-field-icon-color`	Lumo

--vaadin-clickable-cursor

Aura

--vaadin-disabled-cursor

Aura

--vaadin-icon-size

Aura

--vaadin-icon-visual-size

Aura

--vaadin-input-field-button-text-color

Aura

--vaadin-input-field-icon-size

Lumo

--vaadin-input-field-icon-color

Lumo

CSS Selectors

The following CSS selectors can be used in stylesheets to target the various parts and states of the component. See the Styling documentation for more details on how to style components.

Root element: vaadin-text-area

States

Required: vaadin-text-area[required]
Focused: vaadin-text-area[focused]
Keyboard focused: vaadin-text-area[focus-ring]
Read-only: vaadin-text-area[readonly]
Disabled: vaadin-text-area[disabled]
Not empty: vaadin-text-area[has-value]
Hovered: vaadin-text-area:hover

Field

Field surface (background, border): vaadin-text-area::part(input-field)
Native input element: vaadin-text-area > textarea
Input field with placeholder shown: vaadin-text-area > textarea:placeholder-shown
Clear button: vaadin-text-area::part(clear-button)
Clear button icon: vaadin-text-area::part(clear-button)::before
Prefix element: vaadin-text-area > [slot="prefix"]
Suffix element: vaadin-text-area > [slot="suffix"]

Label

Field with label: vaadin-text-area[has-label]
Label: vaadin-text-area::part(label)
Label text: vaadin-text-area > label
Required indicator: vaadin-text-area::part(required-indicator)

Helper and Validation Error

Field with helper: vaadin-text-area[has-helper]
Helper: vaadin-text-area::part(helper-text)
Helper text: vaadin-text-area > [slot="helper"]
Invalid field: vaadin-text-area[invalid]
Field with error message: vaadin-text-area[has-error-message]
Error message: vaadin-text-area::part(error-message)
Error message text: vaadin-text-area > [slot="error-message"]

Docs

Docs

Text Area Styling

Style Variants

Style Properties

Field Surface

Common Properties

Field States

Label

Helper

Error Message

Field Buttons

CSS Selectors

States

Field

Label

Helper and Validation Error