List¶

Pagination section [[]]¶

• Visible Rows: Controls how many rows are visible in the table, or you can select “Show All.” The default setting is 10 rows; this choice is displayed at the bottom of the table and can be overridden by the end users, who can also navigate through the “pages” of records.

Note

Searches, sorting, and filters will query the entire set of records—even the rows that haven’t been loaded into the List yet.

• Show Page Size Dropdown: Checked by default, this displays a page size indicator at the bottom of the list. This indicator allows users to chose to display more or fewer records per page, overriding the Visible Rows setting.
• Reset pagination on Query: Click to reset to the first page after any edits or queries to the model.

Advanced section [[]]¶

• Unique Id (optional): Skuid automatically generates an alphanumeric Id for the component; if preferred, give it a practical name.

Other section [[]]¶

• Row Actions on Left: By default, Row Actions are displayed on the right. If checked, they will be displayed on the left.

• Show “Load more” button: If the Max # of records property on the model is set to a limiting number, checking this allows the end user to load additional records.

• Show Header: If checked, the List header will display.

• Show Footer: If checked, the List footer will display.

  Note

  Hide Header/Hide Footer supersedes any settings for individual elements in the Header or Footer. For example, if Show Search Box is checked in the Filters and Search tab, but Hide Header is also checked, the search box (which sits within the header) will not display because the header is hidden.

Search Properties [[]]¶

• Show Search Box: If checked, Skuid displays a search box above the component.

• Search Method: Determines if a search will query the server and filter its data, or filter local data on the client.

  • Server (default): Returns search results from all data on the server.

  • Client: Returns search results from only the data that is currently loaded on the page. Large data sets may require lengthy time to filter. If end users commonly need to sort only the data they have loaded within the page—as opposed to every record on the server—this property may speed the filter process.

    Warning

    If the server contains a large data set not yet loaded into the page, but Search Method is set to Client, the filter may return incomplete results because it’s filtering incomplete data. This may result in unexpected omissions.

• Tokenize Search Terms: If checked, each word typed into the search bar is “tokenized” — meaning each word is searched for individually. A tokenized search for “George Washington” returns any record with “George” and “Washington”. For example, “George Washington,” “George Michael Washington,” and “George is headed to Washington”. An untokenized search for “George Washington” returns only records with “George Washington” exactly.

• Search box placeholder text: The text that appears in the search box before the end user starts a search. (The default is “Search.”)

• Empty Search Behavior lets you determine what happens when the search box is emptied.

  • Re-query for Model Data (default): The data displayed in the component returns to the state it was in when you first loaded the page.

  • Remove all Model Data: The data is removed from the component and its associated model (but not from the data object/entity).

    Note

    Why do this? If you want to use a component to display the list of search results—handy when you have a lot of search results—you need to have an empty component each time you do a new search, so you can display the newly returned results in it. Without this property, the component’s model will be re-queried when the text is cleared from the search box.

Search Fields [[]]¶

Specifies which fields will be searched against from the component’s search bar.

Note

Depending on the data source used for the model attached to the component, this property may not be available.

• Use SOSL to improve search performance (Salesforce data sources only): SOSL quickly can search multiple objects at a time within a single search query. SOSL does not directly search the database, but instead queries an index of Salesforce text fields. Individual search fields may not be added when this property is enabled.

  Warning

  Because the search is against the index, results are limited to what is present in the index, and will not include data that may have been recently updated in the database. The index updates very quickly, but expect a delay of up to 30 seconds between changes made to the database, and their appearance in the search results.

  Note

  SOSL can search Text fields (including Long Text fields), but not Picklist fields and Reference fields.

  • Fields to Search: Sets which Types of fields to query with SOSL. The options are:

    • Name Fields (default)
    • All Text Fields
    • Email Field
    • Phone Fields
    • SideBar Fields (Name, Phone, Email, External Ids)

    Searches on Salesforce data sources can use one of two query languages: SOQL or SOSL. SOQL can only search one object at a time in a single query, but searches all searchable fields in that object in real-time.

• Fields: Skuid searches on searchable fields by default. Search can be narrowed to individual fields by clicking add Add new Search Field, and then using the field picker to select the field.

  Note

  • (Salesforce data sources only) SOQL can search Picklist fields and Reference fields, but not Long Text fields.
  • You can add multiple search fields.

  • Search Operator: Select from the following logical operators:

    • =
    • starts with
    • Contains

Skuid on Salesforce [[]]¶

By default, Salesforce Objects use SOQL. To ensure proper functionality, enable the Allow Search property on any Salesforce objects to be included in the search.

For more information on using these search options with Salesforce, check out Salesforce’s SOQL and SOSL Reference Guide.