Lists

This article will provide a comprehensive overview of List views and the customizable settings they offer.

What are Lists?

List views are used to display multiple records from a table in your database using a flexible layout of rows.

Any of the fields from that table can be used as details in the list. Each record in a list can be linked to a child scene to edit or view more details about that record.

Managing List Views

Adding, editing, and deleting views are managed the same regardless of view type. To learn how to add, edit, and delete list views from your app, see our article: About Views. 

List Settings

To access the settings of a list view, hover your mouse over the view and click on the pencil icon that appears at the top left of the view. This will open options for Source, List Settings, and List Details which can be edited in the toolbox to the left of the page preview.

Source: Which Records to Display

The source section is used to control which records the list will display and how they will be displayed. Here you can add filters to limit records, define the sorting, and limit the number of records shown. 

• Data: By default, the list will display all the records from the table. However, you can use the data section to add rules that will allow you to limit which records are displayed.
• Sort: Determine the default order in which records will be displayed first.
• Limit: You have the option to display all available records or choose to limit the number of records shown.

List Settings: Options and Settings

The List Settings section offers a range of options for customizing the appearance of your list and determining how users can interact with it in the Live app.

Here's a quick rundown of the available settings in the List Settings section:

• List Layout: The list layout allows you to display the records in your list in 1, 2, or 3 columns.
• Options: 
  • Hide fields without values: Enabling this option will hide any fields in the list view that do not contain a value in the corresponding record.
  • Keyword Search: Displaying a keyword search will present a search field above the list for the user to enter keywords to filter which records will display. These keywords will search the entire record.

    • On the search results display, a “reset” link will appear. Clicking this will reset all search criteria to easily search again with new criteria.

    • The keyword search will be combined with any rules added to the Data Source section.
    • You have the option to select which fields in the table will be used for searching: the fields being used in the view or all fields in the table. 
  • Allow Record Exporting: Enabling the export feature allows users to easily export all the data from the list into various formats. Once enabled, an export link will appear in the top left corner of the list view, providing options for downloading the data in formats such as CSV, Text, or JSON.
    • The exported data will always reflect the exact data the list is displaying, including any sorting and filters.
  • Empty List Text: This will allow you to input what text will show when there are no records to display. 
• Pagination: Pagination determines how many records will show at one time. If the total number of records exceeds the number set here, then links will be added to the list to navigate to additional pages, displaying more records. 
  • The pagination section contains three features that you can enable to customize your list view:
    • Display (10, 25, 50, or 100) records at a time: This option allows you, as the builder, to select how many records are displayed in the Live App by default.
    • Let the user change the amount: This feature enables users in the Live App to modify the number of records they view per page.
    • Repeat pagination controls below the view: This will display pagination controls at the bottom of the list as well as at the top. By default this will be the "page X of X" display. If the feature to allow users to set how many records to view per page is enabled (see previous bullet point) this option will also show at the bottom of the list.
• Filter Options: The options in the Filters section allow you enable or disable filters for your users in the Live App. Filters give the user tools to further refine which records the list will show. 
  
  • Don’t allow records to be filtered: This option will remove filter options from the list view and your users will not be able to filter the records.
  • Allow users to add custom filters: This feature enables your users to customize their filters by allowing them to add their own custom filters. You have the option to specify whether all fields in the table can be filtered or only the fields that are present in the list view. Additionally, you can include starting filters that will be automatically applied when the page is loaded.
  • Use a filter menu: This allows you to set a predefined filter menu that your users can navigate through. With this option users can’t add their own custom filters.

• Title & Description: This section allows you to customize the title and description for the list view. 
  • The title will be added directly above the view in your Live App.
  • The description will be added above your view below the title. Descriptions can be used to give your users more context about how to use a view. 

Lists Details: Add Fields and Links

In the List Details section, you have the ability to customize the content that is available in the list view. Here, you can easily add or remove fields, as well as include action links and static elements to enhance the list view.

This section is divided into the following areas: 

• Details Layout
  • Label Format: This setting allows you to customize how the title of your fields will be aligned in the view. You have the options to choose between none- hide label, top- above the value, left-aligned, and right-aligned. 

• • Layout: This setting allows you to choose between different layout options for positioning of the field columns.
• Add Details:
  
  • Fields: Here you can add and remove fields from the primary table of the record being displayed.
  • Connections: In this section, you have the ability to add or remove fields from any connected tables that are linked to the primary table of the record being displayed.
  • Actions: In this section, you have the option to include links for various actions such as editing, deleting, viewing more details, triggering an action, or linking to another page.
  • Static: In this section, you have the flexibility to include more titles, instructions, or dividers within your list view.

Adding Fields

To include a field in your list view, you have the option to either click on the field in the list within the toolbox or simply drag and drop the field into the details view in the preview.

Editing Fields

To modify a field on the list view, simply hover over the field in the preview and click on the pen icon. This will open up the Item Properties in the toolbox on the left-hand side.

From there, you can make changes to the label format, label title, and styling.

Removing Fields

To remove fields from your list view, hover over the field in the page preview and click the trash can icon.

Adding Actions

The actions tab allows you to add links which trigger actions to your list view. Action links can be used to do things like add links to edit or delete the record, link to another page, or trigger an action. 

These are the following action links available:

• Edit record: This action will generate a new child page with a form for editing the record. Clicking on the link will navigate to that page for editing the record.
• View record details: This action will generate a new child page that will display comprehensive details of the record. By clicking on the link, users will be directed to that page to view the specific details.
• Delete record: This will include a link to delete a record. When the user clicks on the link, they will be prompted to confirm the deletion. Selecting "OK" will then remove the record from the app.
• Link to another page: Instead of creating a new page, you have the option to link to a page that you have already created. For instance, if you have a detailed scene displaying contact record information, you can link to that scene instead of duplicating it.
• Trigger an action: This feature allows you to include a link that will activate an action, such as updating a record, updating a connected record, inserting a connected record, or sending a custom email.

Adding Static Elements

In addition to fields from your tables, you can also add static elements to your list view from the List Details section under "Add Details". This includes additional title/copy and dividers to help add more context to your list view. 

• Title/Copy: This feature allows you to include a section where you can display additional text content as either a section title or description.
• Divider: This feature allows you to add a divider in the list view wherever you place it. It is a useful tool for organizing your list view into distinct sections.