Table¶

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.

• Search results: Determines which results are displayed based on the end user’s search query.

  • Match exactly: Results are only shown for records that contain the search term verbatim.

    If the user searches for George Washington, only the records containing George Washington exactly as written—with no other terms in between—would be displayed.

  • Contain all terms: Results are shown for records that contain all of the terms in the query, even if they may appear in a different order or disconnected from each other.

    If the user searches for George Washington, any record containing George and Washington would be displayed, as long as both terms were anywhere within the record.

  • Contain at least one term: Results are shown for records that contain any of the terms in the query.

    If the user searches for George Washington, any record containing George or Washington would be displayed.

  • 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: Determines 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).

      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.

• Field: 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.

Sort properties [[]]¶

These properties determine the appearance and behavior of the Sort Builder.

• Show sort builder: Check to display the Sort Builder in the component at runtime.
  • Button icon: The icon to display next to the label. Click the icon picker to select a different icon.
  • Button label: The label text that appears on the Sort Builder at runtime. Change the text to match what you want to say to your end users.
• Sort client-side: Check to only sort on field values that are loaded into the page at the time the sort is applied. This means that the sort will be applied to data in the model, not to data still on the server.

Pagination section[[]]¶

start-line:	48
end-line:	87

Display tab [[]]¶

Table height 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 table yet.

• Show page size dropdown: Checked by default, this displays a page size indicator at the bottom of the list. This indicator allows end users to choose to display more or fewer records per page, overriding the Visible Rows setting.

• Always reset pagination after save or query: Click to reset to the first page after any edits or queries to the model.

Row height section[[]]¶

• Medium

• Tall

• Custom: Uses a custom height.

  • Custom Height: The height of the table, using a number and a sizing unit

Drawers section[[]]¶

• Min height: The minimum height of the row, using a number and a sizing unit.

Configuration section [[]]¶

Errors section [[]]¶

Advanced section [[]]¶

• Via Table settings modal: Users set the number of columns to freeze using the Number of Columns to Freeze option in the dots-vertical Table Settings modal.
• Either by drag and drop or via Table settings: Users adjust columns using either the drag and drop method, or via the dots-vertical Table Settings modal.

Note

Allow users to freeze columns helps end users navigate tables with extensive columns. Using this feature with drawers can produce a confusing user experience.

Other section [[]]¶

Export options [[]]¶

• Use table columns as export columns: If checked, the Table will export all columns added to the Table. If unchecked, Export Columns is displayed in the Properties Pane allowing users to add new columns and customize which fields are exported.

  Note

  Checking Allow Users to Show/Hide Column on a field’s properties will not affect which columns are exported. If users hide columns within a Table, their export will still include all columns within the component.

• Append row ID column: If checked, a column will be added to the export which contains the ID of each exported row.

• Attempt to load in all records before export: If checked, Skuid will load every available record before exporting.

  Warning

  Some data sources may limit how many records are returned in one call. If a call tries to return records that exceed a data source’s stated limit, an error will be returned and the export will fail.

• Custom file name: If set, the value of this field will be used as custom name for the exported CSV file.

Export columns [[]]¶

These properties allow end users to configure and customize the columns they’d like to export into a CSV file.

• Column type: The type of column used in the export:
  • Field: This option allows you to select a single field for export. Unselected columns will not be exported.
    • Field: The specific model field to export, selectable from picklist populated with fields from the connected model.
    • Header type: Determines what column header text is displayed in the exported CSV:
      • Use field label: If checked, the exported CSV will display the field’s Label metadata, which is often a less-technical, human-readable name. For example: Account Name or Employees
      • Use field API name: If checked, the exported CSV will display the field API name, which is often used by systems for data import or other backend processes. For example: Name or NumberOfEmployees.
      • Custom label: If checked, the exported CSV will display a custom label instead of any associated label or API name.
        • Label: The custom text to be displayed as a column header.
  • Template: Use template column types to include multiple fields in one column through merge syntax.
    • Template: Specifies which fields the template should include by either selecting them from the field picker, manually entering their merge variables, or using custom text.
    • Label: The custom text to be displayed as a column header.