Text List (ALPHA)
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
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.
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" }])