Reference & Documentation

A Textarea component.
Textarea is a wrapper for the <textarea> HTML5 element.
For detailed attribute info see:

Access this documentation in your Python terminal with:


Our recommended IDE for writing Dash apps is Dash Enterprise’s
Data Science Workspaces,
which has typeahead support for Dash Component Properties.
Find out if your company is using
Dash Enterprise

children (list of or a singular dash component, string or number; optional):
The children of this component.

id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components in
an app.

n_clicks (number; default 0):
An integer that represents the number of times that this element has
been clicked on.

n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was changed
most recently.

disable_n_clicks (boolean; optional):
When True, this will disable the n_clicks prop. Use this to remove
event listeners that may interfere with screen readers.

key (string; optional):
A unique identifier for the component, used to improve performance by
React.js while rendering components See for more info.

autoFocus (a value equal to: ‘autoFocus’, ‘autofocus’ or ‘AUTOFOCUS’ | boolean; optional):
The element should be automatically focused after the page loaded.

autoComplete (string; optional):
Indicates whether controls in this form can by default have their
values automatically completed by the browser.

cols (string | number; optional):
Defines the number of columns in a textarea.

disabled (a value equal to: ‘disabled’ or ‘DISABLED’ | boolean; optional):
Indicates whether the user can interact with the element.

form (string; optional):
Indicates the form that is the owner of the element.

inputMode (string; optional):
Provides a hint as to the type of data that might be entered by the
user while editing the element or its contents. The attribute can be
used with form controls (such as the value of textarea elements), or
in elements in an editing host (e.g., using contenteditable attribute).

maxLength (string | number; optional):
Defines the maximum number of characters allowed in the element.

minLength (string | number; optional):
Defines the minimum number of characters allowed in the element.

name (string; optional):
Name of the element. For example used by the server to identify the
fields in form submits.

placeholder (string; optional):
Provides a hint to the user of what can be entered in the field.

readOnly (string; optional):
Indicates whether the element can be edited.

required (a value equal to: ‘required’ or ‘REQUIRED’ | boolean; optional):
Indicates whether this element is required to fill out or not.

rows (string | number; optional):
Defines the number of rows in a text area.

wrap (string; optional):
Indicates whether the text should be wrapped.

accessKey (string; optional):
Keyboard shortcut to activate or add focus to the element.

className (string; optional):
Often used with CSS to style elements with common properties.

contentEditable (string; optional):
Indicates whether the element’s content is editable.

dir (string; optional):
Defines the text direction. Allowed values are ltr (Left-To-Right) or
rtl (Right-To-Left).

draggable (string; optional):
Defines whether the element can be dragged.

hidden (a value equal to: ‘hidden’ or ‘HIDDEN’ | boolean; optional):
Prevents rendering of given element, while keeping child elements,
e.g. script elements, active.

lang (string; optional):
Defines the language used in the element.

role (string; optional):
Defines an explicit role for an element for use by assistive

spellCheck (string; optional):
Indicates whether spell checking is allowed for the element.

style (dict; optional):
Defines CSS styles which will override styles previously set.

tabIndex (string; optional):
Overrides the browser’s default tab order and follows the one
specified instead.

title (string; optional):
Text to be displayed in a tooltip when hovering over the element.

loading_state (dict; optional):
Object that holds the loading state object coming from dash-renderer.

loading_state is a dict with keys:

  • component_name (string; optional):
    Holds the name of the component that is loading.

  • is_loading (boolean; optional):
    Determines if the component is loading or not.

  • prop_name (string; optional):
    Holds which property is loading.