Textarea

A component representing the textarea element. This component allows the user to input multiline text.

Component render

Screenshot of the textarea Dashboard Add-Ons UI component

<Textarea
  label="Label"
  onChange={(value) => console.log(value)}
/>

Properties

Property Type Description
autofocus boolean A boolean representing whether the input should focus on page load. If multiple elements with autofocus are present, it is not guaranteed which one will ultimately receive the focus. It is advised that only one at most is present.
disabled boolean A boolean representing whether the textarea is disabled or not. This visually and functionally will disable the textarea.
inputmode string Allows a browser to display an appropriate virtual keyboard. Accepted values.
invalid boolean A boolean representing whether the textarea is invalid or not. This represents error states.
label string The label for the textarea, which will appear right above the textarea.
maxlength string A string specifying the maximum length of characters for the input value.
name string A string specifying a name for the textarea.
onChange (value: string) => void As the value of the textarea changes, this function will send back the value of the textarea.
placeholder string A string specifying the placeholder of the textarea. This is shown before a user attempts to add a value, given no value is already provided.
readonly boolean A boolean representing whether the textarea is readonly or not.
value string A string specifying a value for the textarea. This will be visually shown on the textarea and can be edited by the user.