Skip to main content

Text List (ALPHA)

Alpha feature: invite only

Responsive Widgets are in alpha and available by invitation only on Business and Enterprise plans. Behavior and properties may change. To request access, open a support ticket and name the feature Responsive Widgets (ALPHA).

The Text List widget shows an array of objects as a vertical list. Each row shows a primary text and an optional secondary text. Use it for simple lists, such as names with job titles. To build rows from other widgets, use the List widget.

Widget type: WDS_LIST_WIDGET

Text List widget in a Responsive app
Text List widget

Content properties​

These properties appear in the Content tab of the property pane.

Data​

List data array​

Sets the array of objects to show as rows. New widgets start with three sample rows.

Example:

{{getUsers.data}}

Primary text key string​

Sets the object key to use for the primary text of each row. Default: name.

Secondary text key string​

Sets the object key to use for the secondary text of each row. Optional. Default: detail.

General​

Visible boolean​

Controls whether the widget is visible. Default: on.

Animate loading boolean​

Controls the loading animation of the widget. Default: on.

Style properties​

These properties appear in the Style tab of the property pane.

Custom styling​

These settings are in the Custom styling section, at the end of the Style tab. An empty setting uses the theme value. For theme colors, dark mode, and the rules for custom CSS, see Custom styling.

Accent color string​

Builds the hover, pressed, focus, and text colors of this widget from one color, in light and dark mode. Lists and menus that the widget opens use them too. Empty means the accent of the nearest container that sets one, or the theme accent.

Background string​

Sets the background of the widget surface. Takes a theme color or a custom color.

Text color string​

Sets the text color of the widget surface. Takes a theme color or a custom color. When it is empty and Background is set, the widget picks a readable text color.

Border color string​

Sets the border color of the widget surface. Takes a theme color or a custom color. A color with no Border width draws a thin border.

Border width string​

Sets the border width of the widget surface. Options: From theme (default), None, Thin, Medium, Thick. You cannot bind this property.

Corners string​

Sets the corner radius of the widget surface. Options: From theme (default), Sharp, Rounded, Pill. You cannot bind this property.

Custom CSS string​

Adds plain CSS to this widget. Rules apply only inside the widget, and & is the widget surface. You cannot bind this property.

Reference properties​

Reference properties let you read the widget's state in bindings and code, for example {{List1.isVisible}}. You cannot set them directly.

isVisible boolean​

Shows whether the widget is visible.

Example:

{{List1.isVisible}}

listData array​

Holds the data in the list.

Example:

{{List1.listData}}

Methods​

Methods let you change the widget's properties from code, for example in a JS Object.

setVisibility (param: boolean): Promise​

Shows or hides the widget.

Example:

List1.setVisibility(false)

setData (param: array): Promise​

Sets the list data.

Example:

List1.setData([{ name: "Ada Lovelace", detail: "Engineer" }])