Skip to content

text_area

Displays a multi-line text input widget and maps its value to the backend as a string.

Basic use

{% text_area name="my_input" %}
from simmate.website.core_components.components import DynamicFormComponent

class ExampleView(DynamicFormComponent):
    my_input = "some default value"

Parameters

Parameter Description
name The unique name or identifier for the input field. This should match the name of your class attribute in the backend.
Type: str, Default: —
label The display label for the input field. If not provided, the name may be used as the label.
Type: str, Default: None
show_label Whether to display the label alongside the input field.
Type: bool, Default: True
help_text Optional helper text to be shown alongside the input field.
Type: str, Default: None
placeholder The placeholder text to display when input field is empty.
Type: str, Default: "Enter details..."
ncols The number of columns that the text area should render with.
Type: int, Default: 4
nrows The number of rows that the text area should render with.
Type: int, Default: 30
defer Whether to defer processing or submission of the input value.
Type: bool, Default: True