Skip to content

Properties

PropertiesDescription
value(optional) the content value of the Textarea.
align(optional) defines the text-align of the Textarea. Defaults to left.
stretch(optional) if set to true, then the Textarea field will be 100% in width.
placeholder(optional) the placeholder which shows up once the Textarea value is empty
label(optional) prepends the Form Label component. If no ID is provided, a random ID is created.
label_direction(optional) use label_direction="vertical" to change the label layout direction. Defaults to horizontal.
suffix(optional) text describing the content of the Textarea more than the label. You can also send in a React component, so it gets wrapped inside the Textarea component.
label_sr_only(optional) use true to make the label only readable by screen readers.
autoresize(optional) use true to make the Textarea grow and shrink depending on how many lines the user has filled.
autoresize_max_rows(optional) set a number to define how many rows the Textarea can auto grow.
status(optional) text with a status message. The style defaults to an error message. You can use true to only get the status color, without a message.
status_state(optional) defines the state of the status. Currently, there are two statuses [error, info]. Defaults to error.
status_props(optional) use an object to define additional FormStatus properties.
globalStatus(optional) the configuration used for the target GlobalStatus.
textarea_state(optional) to control the visual focus state as a prop, like focus or blur.
textarea_class(optional) in case we have to set a custom Textarea class.
textarea_attributes(optional) provide the Textarea element with any attributes by using an Object textarea_attributes={{size:'2'}} or a JSON Object textarea_attributes='{"size":"2"}'. NB: Keep in mind, that also every not listed component property will be sent along and set as a Textarea element attribute.
inner_ref(optional) by providing a React.ref we can get the internally used Textarea element (DOM). E.g. inner_ref={myRef} by using React.createRef() or React.useRef().
skeleton(optional) if set to true, an overlaying skeleton with animation will be shown.
Space(optional) spacing properties like top or bottom are supported.

Set Textarea height

You can set the height of a Textarea by both CSS styles or the rows attribute.