Skip to content

Textarea - Web Component โ€‹

The Textarea component can be used imported from:

Parameters โ€‹

The Web component uses the <z-textarea> tag:

By default, all the parameters are optional or can be set in different, except for the ones marked as required

The parametrization of the component can be done with the following custom HTML params:

NameTypeDescriptionSlotA11y
configstring

The main parameter has two components following the pattern: <shape><?:size>.

  • shape: Establishes the styling of the input. Default value is line . Possible values are: shaped or line. ,
  • size: (optional) defines de size of the input. The default value is m, being omitted from the param. The possible values are: m or l.
labelstringLabel of the inputlabel
readonlybooleanTransforms the input into an output
valuestringValue of the model
disabledbooleanBlocks the interaction with the input component.
requiredbooleanMarks the input component as required.
namestringIdentification for the field inside the form
help-textstringThe forced message to be shown under the inputhelp-text
invalidbooleanThe forced state for set the input as invalid
elasticbooleanMakes the textarea auto-grow on typing

Events โ€‹

This component has events. Check the documentation about how to use the events.

NamePayloadDescription
changestringReturns the new value of the "value" attribute
entervoidTriggered when "Enter" in pressed
restartedvoidEmitted on value reset

Slots โ€‹

This component has slots. Check the documentation about how to use the slots.

NameTagsDescription
defaultspan

Parameters use โ€‹

config โ€‹

The config parameter is used to set the shape of the input between lined and shaped. Being omitted will render the default line shape.

label โ€‹

The label parameter is used to set the text label of the component. Make sure you always use it.

readonly โ€‹

The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.

value โ€‹

The value parameter is used to set the text for the input.

disabled โ€‹

The disabled parameter is used to block the interaction with the component. Not to be confused with readonly.

required โ€‹

The required parameter is used to set the component as required.

name โ€‹

The name parameter is used to set the name of the component. This is useful when the component is part of a form.

invalid โ€‹

The invalid parameter is used to set the component as invalid.

help-text โ€‹

The help-text parameter is used to provide additional assistance to the user.

max-length โ€‹

The max-length parameter is used to set the maximum number of characters that the user can input. A counter will be displayed below the input.

elastic โ€‹

The elastic parameter is used to set the textarea to grow and shrink automatically to fit the content.

Playground โ€‹

Browser support โ€‹

Detected engine: ย 

  • Chromium

  • Webkit

  • Gecko

HTML Examples โ€‹

CodeSandbox example โ€‹