Textarea - Web Component

The Textarea component can be used imported from:

Playground

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:

Name	Type	Description	Slot	A11y
config	string	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.
label	string	Label of the input	label
placeholder	string	Placeholder of the input
readonly	boolean	Transforms the input into an output
autocomplete	string	Automated assistance in filling out form field values
model	string	Value of the model
disabled	boolean	Blocks the interaction with the input component.
required	boolean	Marks the input component as required.
name	string	Identification for the field inside the form
help-text	string	The forced message to be shown under the input	help-text
invalid	boolean	The forced state for set the input as invalid
max-length	number	The maximum number of characters allowed in the textarea
elastic	boolean	Makes the textarea grow with its content

Events

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

Name	Payload	Description
change	string	Returns the new value of the "value" attribute
enter	void	Triggered when "Enter" in pressed
restarted	void	Emitted on value reset

Slots

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

Name	Tags	Description
label	span
helper-text	span

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.

Can also use the label slot:

Textarea input

model

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

name

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

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.

Flags

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.

readonly

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

invalid

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

elastic

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

Methods

reset()

We can all the reset() method of the WebComponent in order to reset the value. This will clean the internal states and emit the nullable value with the change event, plus a restarted event:

In this example, the button triggers the method:

Value:  undefined

Browser support

Detected engine:  

• Chromium

• Webkit

• Gecko

HTML Examples

CodeSandbox example