Snap to Place
Powered By GitBook
List Viewer
The List Viewer component allows you to add, view and click on items in a list.

Add Items to a List Viewer

Short Lists

We recommend adding a short list of items within the app itself as the Screen starts. Although the list block itself can handle a large number of items, practically speaking you probably only want to use this approach if your project has tens of items.

Medium Lists

If you need longer lists of information in your app you can use delimited data. This is very similar to using something like a .csv file. You can have hundreds of items in your list viewer using this method.

Long Lists

For longer lists where you need hundreds or thousands of items in your list, we recommend using the Data Sources component. This gives you three different options for storing your data.
    1.
    Local Table
    2.
    Airtable
    3.
    Google Sheets
Fetching data from a Local Table
Getting data from an Airtable Table
Reading data from a Google Sheet
Choosing Airtable or Google Sheets allows you to create dynamic list viewers. This is where the information displayed to the user changes whenever you change your cloud-based data in Airtable or Google Sheets. Either of these options are ideal for when you need to store thousands of items, or you need to work with items that change frequently.
Property
Description
Text Items
Default (none); items must be in list format

Select Item from a List Viewer

Property
Description
Item Click
Returns an item value and a numeric index number when an item is selected

Style the List Viewer

You can customize the List Viewer with the following properties:
    Text Items Color: Set color of Text Items font
    Text Items Background Color: Set background color for List Viewer
    Text Items Font Size: Set font size of Text Items
    Show Arrow: To see an arrow beside each item in the list, set the switch to true
    Visible: To see the text input in your app, set the switch to true
    Border
      Width: Enter how wide you want the border outline of the List Viewer to be
      Color: Pick a color for the border of the List Viewer
      Style: Select if you want the border to be a dotted, dashed or solid line
      Radius: Enter how round you want the edges of the border for the List Viewer to be

Edit the ListViewer Height

A List Viewer automatically fill 100% of the Screen width
You can set how tall the List Viewer is using the height property.
Height
    Fill container - The List Viewer fills the entire screen vertically
    Fit contents - The List Viewerโ€™s height changes to fit the contents it contains
    Relative size - The List Viewer fills the specified percentage of the screen
    Absolute size - Sizes the List Viewer to a specified number of pixels

Add Spacing

You change the spacing and positioning of the List Viewer with the Margin and Padding properties.
Margin
    You can specify how much space you want between the border and the contents of List Viewer using either pixel or percent values.
Padding
    You can specify how much space you want between the edges of the List Viewer and the screen using either pixel or percent values.

Events

Performs an action when the user clicks on any one of the list items.

Properties

Height

The set and get height blocks work with the Height property of the list viewer component. Acceptable input values are.
    Number of Pixels
    Percentage Height
    "Fit Contents"
    "Fill Container"
The Computed Heightblock returns the on-screen dimensions of the list viewer, after it has been rendered on-screen. The value returned is an integer, representing the size of the list viewer in pixels.

Show Arrow

Choose whether or not the arrow is displayed next to every item in the list viewer.

Text Items

Set or get the list of text items that are displayed in the List Viewer. You must use a list of data here - either locally stored or stored in the cloud.

Visible

โ€‹
The set and get visible blocks are used to show or hide the entire list viewer component. Acceptable values are:
    True
    False

Width

The Computed Widthblock returns the on-screen dimensions of the list viewer, after it has been rendered on-screen. The value returned is an integer, representing the size of the list viewer in pixels.
The list viewer doesn't currently support pixel or percentage values for the width property.
Last modified 3mo ago