mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 14:07:26 +00:00
11d38325cb
* add app-builder doc updates on Table and themes * breakdown chart docs in two parts and add custom css for headers * update chart example images and add more examples * revamp table component and minor fixes * fix typos * fix table formatting for docusarus v3 * fix filepicker table * create new version * fix grammar and tables
74 lines
4.4 KiB
Markdown
74 lines
4.4 KiB
Markdown
---
|
|
id: textarea
|
|
title: Textarea
|
|
---
|
|
# Textarea
|
|
|
|
The **Textarea** component allows users to enter text in an input field similar to the [Text Input](/docs/widgets/text-input) component. Textarea is generally preferred when we are expecting an input of multiple sentences. In this document, we'll go through all the configuration options for the **Textarea** component.
|
|
## How To Use Textarea Widget
|
|
|
|
<iframe height="500" src="https://www.youtube.com/embed/ja66x6DeZxk" title="Textarea Widget" frameborder="0" allowfullscreen width="100%"></iframe>
|
|
|
|
## Properties
|
|
|
|
| Property | Description | Expected Value |
|
|
|:-------------|:------------------------------------------------------------|:------------|
|
|
| Default value| Used to set initial value in textarea on load. It is a pre-established value that can be retrieved from the Text area component if no modifications are made to it. | Enter some text as the value (example: "John Doe")|
|
|
| Placeholder | Provides a hint for the expected value. It disappears once the user interacts with the component. | Enter some instructional text as the value (example: "Type name here") |
|
|
|
|
## General
|
|
|
|
<font size="4"><b>Tooltip</b></font>
|
|
|
|
A **Tooltip** is commonly used to provide additional information about an element. This information becomes visible when the user hovers the mouse pointer over the respective component.
|
|
|
|
In the input field under **Tooltip**, you can enter some text and the component will show the specified text as a tooltip when it is hovered over.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
<img className="screenshot-full" src="/img/widgets/textarea/tooltip.png" alt="Tooltip Example" />
|
|
</div>
|
|
|
|
## Layout
|
|
|
|
<font size='4'><b>Show on desktop</b></font>
|
|
|
|
Use this toggle to show or hide the component in the desktop view. You can dynamically configure the value by clicking on `Fx` and entering a logical expression that results in either true or false. Alternatively, you can directly set the values to `{{true}}` or `{{false}}`.
|
|
|
|
<font size='4'><b>Show on mobile</b></font>
|
|
|
|
Use this toggle to show or hide the component in the mobile view. You can dynamically configure the value by clicking on `Fx` and entering a logical expression that results in either true or false. Alternatively, you can directly set the values to `{{true}}` or `{{false}}`.
|
|
|
|
---
|
|
|
|
## Styles
|
|
|
|
| Property | Description | Expected Value |
|
|
|:---------------|:-----------|:---------------|
|
|
| Visibility | Controls the visibility of the component. If set to `{{false}}`, the component will not be visible after the app is deployed.| Use the toggle button OR click on `Fx` to pass a boolean value or a logical expression that returns a boolean value i.e. either `{{true}}` or `{{false}}`|
|
|
| Disable | Makes the component non-functional when set to true. | Use the toggle button OR click on `Fx` to pass a boolean value or a logical expression that returns a boolean value i.e. either `{{true}}` or `{{false}}`|
|
|
| Border Radius | Adjusts the roundness of the component's corners. | Numeric value|
|
|
|
|
## General
|
|
|
|
<font size="4"><b>Box Shadow</b></font>
|
|
|
|
The **Box Shadow** property is used to add shadow effects around a component's frame. You can specify the horizontal and vertical offsets(through X and Y sliders), blur and spread radius, and color of the shadow.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
<img className="screenshot-full" src="/img/widgets/textarea/box-shadow.png" alt="Box-Shadow Example" />
|
|
</div>
|
|
|
|
## Exposed Variables
|
|
|
|
| Variables | Description | Expected Value |
|
|
|:----------- |:----------- | :-------------|
|
|
| value | This variable holds the value entered in the text area component. | You can access the value dynamically using JS. For example, `{{components.textarea1.value}}`|
|
|
|
|
## Component Specific Actions (CSA)
|
|
|
|
Following actions of the **Textarea** component can be controlled using Component-Specific Actions(CSA):
|
|
|
|
| Actions | Description |
|
|
| :----------- | :----------- |
|
|
| setText | Sets the text on the text area component via a component-specific action within any event handler. Additionally, you have the option to employ a RunJS query to execute component-specific actions such as `await components.textarea1.setText('this is a textarea')`. |
|
|
| clear | Clears the value from the text area component via a component-specific action within any event handler. Additionally, you have the option to employ a RunJS query to execute component-specific actions such as `await components.textarea1.clear()`. |
|