Skip to main content

Text

This page provides information on using the Text widget to display static or dynamic textual information.

Use the Text widget to display data

Content properties​

These properties are customizable options present in the property pane of the widget, allowing users to modify the widget according to their preferences.

General​

Text string​

Sets the text to be displayed. The text remains unchanged until manually updated or edited.

You can dynamically change text by fetching data from queries or JS functions and binding the response to the Text property. For instance, when a row in a Table widget is clicked, the Text widget dynamically displays the specific name associated with that row.

Example:

{{Table1.selectedRow.name}}

You have the option to use HTML code within the Text property to customize the appearance of the displayed text. Note that the Text field supports only inline CSS. If you need to use external CSS, it is recommended to use the Iframe widget.

Example:

<p style="color:blue;">Hello World</p>

This code displays the text Hello World in blue color.

Visible boolean​

Controls the visibility of the widget. If you turn off this property, the widget is not visible in View Mode. Additionally, you can use JavaScript by clicking on JS next to the Visible property to control the widget's visibility conditionally.

For example, if you want to make the widget visible only when the user selects "Yes" from a Select widget, you can use the following JavaScript expression:

{{Select1.selectedOptionValue === "Yes"}}

Animate Loading boolean​

This property controls whether the widget is displayed with a loading animation. When enabled, the widget shows a skeletal animation during the loading process. Additionally, you can control it through JavaScript by clicking on the JS next to the property.

Enabling this option treats any link in the widget as standard text instead of clickable links.

Height string​

This property determines how the widget's height adjusts to changes in its content. There are three available options:

  • Fixed: The widget's height remains as set using drag and resize.
  • Auto Height: The widget's height adjusts dynamically in response to changes in its content.
  • Auto Height with limits: Same as Auto height, with a configurable option to set the minimum and maximum number of rows the widget can occupy.

Style properties​

Style properties allow you to change the look and feel of the widget.

General​

Font family string​

Enables you to choose a font for the text, which can also be programmatically manipulated using JavaScript functions.

Font size string​

Determines the font size of the text. It accepts CSS font-size values and can also be programmatically modified using JavaScript functions.

Color​

Text Color string​

Sets the color for the text, and when JS is enabled, you can dynamically modify the text color using JavaScript functions.

Text formatting​

Alignment string​

Sets the horizontal alignment of the text within the cells.

Options:

  • Left
  • Center
  • Right

Emphasis String​

Allows you to choose a font style for the widget, including options like bold or italic. When JS is enabled, you can dynamically modify the font style using JavaScript functions.

Border and shadow​

Border Width number​

Specifies the width of the widget's border, accepting only numerical values in pixels (px).

Reference properties​

Reference properties are properties that are not available in the property pane but can be accessed using the dot operator in other widgets or JavaScript functions. They provide additional information or allow interaction with the widget programmatically. For instance, to get the visibility status, you can use Text1.isVisible.

text string​

The text property retrieves the current text value of the widget.

Example:

{{Text1.text}}

isVisible boolean​

Reflects whether the widget is visible or not.

Example:

{{Text1.isVisible}}

Methods​

Widget property setters enable you to modify the values of widget properties at runtime, eliminating the need to manually update properties in the editor.

These methods are asynchronous and return a Promise. You can use the .then() block to ensure execution and sequencing of subsequent lines of code in Appsmith.

setVisibility (param: boolean): Promise​

Sets the visibility of the widget.

Example:

Text1.setVisibility(true)

setDisabled (param: boolean): Promise​

Sets the disabled state of the widget.

Example:

Text1.setDisabled(false)

setRequired (param: boolean): Promise​

Sets whether the widget is required or not.

Example:

Text1.setRequired(true)

setText (param: string): Promise​

Sets the text value of the widget.

Example:

Text1.setText('Hello, world!')

setTextColor (param: string): Promise​

Sets the selected option of the Select widget.

Example:

Text1.setTextColor('#FF0000')