Table¶

Change the field character limits¶

When using the counter, the character limits are preset by the data source. (For example, Salesforce sets a limit of 128 characters for string fields, and 3200 characters for textarea fields). These limits are set by the field’s metadata.

To change the limit:

1. Click the model with the field whose limit you want to override, then click Fields.
2. Click the specific textarea or string field.
3. In the Field Description pane, check Override field metadata.
   • Under Length, set the length to the desired number of characters.
4. Click Save.

For more information on field metadata overrides, see Field Metadata Overrides and Cross-Object References.

Basic tab [[]]¶

• Model: The model the Table will display data from.

  Note

  When you have multiple models, make sure you select the correct one!

• Default Mode:

  • Read with Inline-Editing: Displays records in read mode on page load. End users can click fa-pencil Edit to convert to Edit mode. (Checked by default.)

  • Edit: Records display in edit mode on page load; end users can toggle individual records to read mode by clicking fa-pencil Edit. Edit mode is best used for new, clone, and edit pages where you want all table rows open for editing.

  • Read-Only: Records display in read mode and cannot be edited.

    Note

    Skuid works with your data source’s security settings so users will not be able to edit records they don’t have permission to edit (even if the table is set to Edit mode). While you should not use this as a security measure, setting the Default Mode to Read-Only ensures that the end user can not edit the Table’s content on the page.

• Title: The title that displays above the Table. (If left blank, the Table does not have a title.)

• Allow Inline Record Creation: Includes an fa-plus-circle Add New [Record] button at the top of your table; end user can click to add a new record without leaving the page.

• Show Save/Cancel: Check to display the Save/Cancel buttons above the table. (Checked by default.)

• Show Export Button: Check to display the fa-file-excel-o Export Table Data button at the bottom of the table, allowing end users to export the entire table (or selected rows) as a spreadsheet. Once fa-file-excel-o is displayed, clicking it will show Export Properties in the Properties Pane.

• Allow Users to Reorder Columns: If checked, allows users to reorganize their tables in the runtime page. (Checked by default.)

• Make Table Mobile Responsive: Allows the table to adjust to the device’s screen size by stacking table elements instead of displaying them horizontally. (Checked by default.)

• Sort Columns client-side: If a field on a table has Allow Sorting checked in the Field properties, additionally checking Sort Columns client-side means that Skuid will only sort the column field data that is currently loaded on the page. 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 Sort Columns client-side is set to Client, the data in the column will represent only a subset of the complete data set. This may result in unexpected omissions.

• Hide Header: If checked, the Table header does not display.

• Hide Footer: If checked, the Table footer does not display.

  Note

  Hide Header/Hide Footer supersedes any settings for individual elements in the Header or Footer. For example, if Show Save/Cancel is checked—which displays the Save and Cancel buttons—but Hide Header is also checked, the Save and Cancel buttons (which sit within the header) will not display because the header is hidden.

Filters and Search tab [[]]¶

In this tab are properties that control whether or not you have a search box, and when search terms and conditions are applied.

• Filter & Search Behavior:

  • Apply Filters and Search Immediately: If checked, all changes made to filters, or any text typed into the search bar, will be applied immediately. If unchecked, Skuid displays the Apply and Cancel buttons. The changes will not be applied until the end user selects Apply.

    Note

    This is particularly useful when employing multiple filter criteria.

• 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

Display tab [[]]¶

• Pagination

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

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

• Scrolling

  • Allow Scroll Bars: Displays scroll bars when the list of records exceeds screen size. (Unchecked by default.) The scroll bar will not display unless you add a value to Max Table Height.

    • Max Table Height (Optional): The height of the table, which can be set in pixels, em, percentage, vh or vw. Best practice: Start with a mid-range option (for example, 300 pixels), then preview it. Depending upon the size of your table, you may need to increase or decrease this until the scroll bar displays at the table’s right side.

    Note

    While this setting is optional, you must add a value if you want a visible scrollbar on the table.

    • Keep Header Visible: If true, the column header remains visible at the top of the Table no matter how far a user scrolls down the page (This is also known as a “sticky header”).
    • Freeze Left Columns: Useful if you will have many columns in the Table; this freezes the first column (and any row actions) in the left side of the table. Users can scroll to the right to see the additional columns that may not fit on screen, while still seeing the important data in the initial column(s).

    Warning

    If Freeze Left Columns is enabled for a Table that contains many rows (100+) in Salesforce Lightning Experience, the page may load extremely slowly.

    Note

    Freeze columns is not compatible with drawers.

    This feature works best with Chrome or Firefox browsers.

    • # of Columns To Freeze: Select the number of columns to freeze.

• Errors: Choose whether error messages appear inline (next to the field), or only inline if the user hovers over the field.

• Advanced:

  • Button Position: Select where the Save/Cancel buttons and search bar display on the page: Left or Right sides.
  • Unique Id (optional): Skuid automatically generates an alphanumeric Id for the component; if preferred, give it a practical name.
  • CSS Class (optional): Assign a CSS class to the component’s DOM element.
  • Add New Records Icon: Click the icon selector to choose an icon that displays on the table to E*Add New Record*.
  • Table Settings Button Icon: Click the icon selector to choose an icon that displays above and right of the table to open the Table Settings dialog box.
  • Save Icon: Click the icon selector to choose the icon that displays on the Save button.
  • Cancel Icon: Click the icon selector to choose the icon that displays on the Cancel button.

Rendering tab [[]]¶

Conditional rendering allows you to display or hide the Table, based on defined data conditions.

Basic tab [[]]¶

• Field ID: The name of the selected field.

• Custom Label: Use the field picker to select a field to use as the column label. This feature lets you choose another field’s name and re-label the column with it, to shorten or clarify the column’s identity or purpose for end users.

• Allow Sorting: Check this box to display buttons that allow end users to sort the table by this column’s values, both ascending and descending.

  Note

  Columns with sorting allowed have clickable triangles: up-pointed triangles sort the column in Ascending (Z to A) order; down-pointed triangles sort the column in Descending (A to Z) order.

  Warning

  To retain record cohesion, sorting an individual column simultaneously reorders the rest of the table. For this reason, sorting should be used judiciously. It is also recommended not to use more than one sorted column per table.

• Placeholder: Whenever a new row is created within the Table, this placeholder text appears until the end user enters a value. Commonly used to provide instruction for more complex field requirements. This field is compatible with merge syntax.

• Read-only: Check this box to prevent end users from editing this field on this specific Skuid Table. This setting does not persist across Skuid pages.

  Note

  Skuid automatically respects the validation rules and field-level security from your data source.

• Required: Check this box to require end users to have data within this column when saving on this specific Skuid Table. This setting does not persist across Skuid pages and will not override existing data model settings within the data source.

  Note

  Skuid automatically respects the validation rules and field-level security from your data source.

• None Option Label: In a picklist field, there is a “none” item for instances when the end user doesn’t choose any of the picklist’s options. This property changes the label for that “none” item.

• Column Summaries: (Number fields) Add summaries to the bottom of each column: Sum, Average, Min, Max, or Median.

• # of Decimal Places: (Currency and measurement fields) Choose the number of decimal places. Options: 0-8 or use the field’s metadata to determine the number of decimal places.

• Max Characters to Display: Determines the number of text characters to display within the column when the table is in Read mode; does not affect Edit mode, where the full length of the field’s value displays.

• Column Width: The width of the column, in percentages (indicated as %) or pixels (indicated as px).

Warning

Do not mix the use percentages and pixels across columns. Choose one measurement format and stick with it.

• Horizontal Alignment: Choose whether the column content is aligned left (default) or right.

• Field Renderer: Determines how the column will actually display at runtime. All fields have the option of:

  • Standard: Use standard Skuid field renderers, which are based on the type of field selected. (Default setting.)
  • Password: Marks the field as a password input—hiding all characters as asterisks both in Read and Edit mode for all records in the table.
  • Custom (run a Snippet): Use custom-coded table field renderers to take advantage of Skuid’s JavaScript API.

  • Render Snippet Name: The name of the snippet that serves as the renderer.

  Certain field types have different options:

  • Radio Buttons: (Picklists only) Renders the field as radio buttons.

  Note

  For multi-select picklists, Skuid renders a multi-select list of checkboxes instead.

  • Auto-Complete: (Reference fields only) The default for reference fields, this renderer tries to autocomplete entries based on the options available for this field.
  • Picklist: (Reference fields only) Renders the reference field options as a picklist.

Warning

This feature is best used by advanced builders to solve specific user experience needs regarding data display.

• Allow Users to Show/Hide Column: Check to allow end users to choose whether to show or hide this specific column through fa-sliders Table Settings.

• Show Column by Default: If Allow Users to Show/Hide Column is marked true, this field determines whether a column is shown or not on page load. For large tables with many columns, consider unchecking this field for discretionary columns to give users more flexibility in the data they wish on page load, and prevent flooding the page with columns.

• Show Length Counter: When the field is in Edit mode, it displays a character countdown (“25/ 128”) indicating the number of characters used and how many total characters are allowed.

  Note

  • The counter is enabled by default for standard textarea fields.
  • The counter is not available for Salesforce rich text area fields.

• Rows to Display: Set the number of visible lines of text to display for text area fields. If left blank, the text area will auto-expand to display the full content.

Search tab [[]]¶

The Search tab is available for reference fields when the Table is in Edit mode. Search allows end users to search for content from within the model (or from a selected model) when editing a reference field.

This tab lets you format the field search experience. (Looking for standard Search properties? See the Filters and Search tab.)

Link tab [[]]¶

Available for reference fields, the Link tab determines whether an end user can navigate to a referenced record’s detail page (or some other custom URL) by clicking on the record in the table. If using the field as a link, you can set the following properties:

• Navigation Type:

  • Data Source Default: If a data source type has default behaviors configured for reference fields—for example, navigating to a detail page using the record ID à la Salesforce—then that behavior will be used in Skuid.

  • No Link: The reference fields will display as unclickable plain text.

  • Skuid Page: Set the field to link to a Skuid page.

    • Skuid Page: The name of the linked Skuid page.

  • Route: Set the field to link to a route in Skuid Platform.

    • Skuid Route: The name of the route.

  • Custom URL: Set the field to link to a specified URL.

    • URL: The URL that a end user will be taken to. Can accept merge syntax, which can be particularly useful for URL parameters.

    • Open URL in:

      • Current Window:

        • Opens the URL in the current window.

        • If using the Skuid page is within an iFrame, opens the URL in the current iFrame.

          Note

          Other content blocks on the page will remain the same.

      • New Tab: Opens the URL in a new tab.

Filters tab [[]]¶

In partnership with the settings in the Search Tab, the Filters tab lets you create Lookup Filters for the reference fields to limit the search/display content provided when editing reference fields. returned in reference field lookups.

Set the following properties for Lookup Filter conditions:

• Field: The field in the current model to use as a filter for the searchable reference field.
• Operator: The relationship between the field and its filter content.
• Content: The type of value used to filter the reference field’s data.
  • Single specified value: Returns records that meet the specified value.
    • Value: Indicate the value to filter by.
  • Multiple Specified Values: Returns records that meet at least one of the several specified values.
    • Values: Indicate the values to filter by; for each separate value click Add Another Value.
  • Page/URL Parameter value (Skuid on Salesforce): Returns records that meet the specified Salesforce Lightning page or URL parameter, for example, the id parameter.
    • Parameter: Indicates the specific parameter to filter by.
    • If this Parameter is not provided, then …
      • Set its value to Blank
      • Deactivate this Condition
      • Abort this Model’s Query
  • Running user attribute: Returns records if the value of a field on the model matches the value of a field on the current user’s record.
    • Userinfo Property: The value on the current user’s record to be used as a filter, usually an Id property.
  • Field from another model: Use a field from another model as the filter for the Lookup field.
    • Source Model: The name of the model.
    • Source Field: Field on the source model.
    • If no row in Source Model, then …
      • Deactivate this Condition
      • Abort this Model’s Query
  • None - blank value: Returns records only if the specified field is empty.
  • Another field from row: Returns records only if the field on the referenced record matches a separate field on that same record.
    • Depends On: Select the field to compare with.

Advanced tab [[]]¶

The Advanced tab displays for date- or time-related fields.

• Show Month Picker: If checked, a Month picker is displayed during Edit Mode, to make it easy to jump to a specific month.
• Show Year Picker: If checked, a Year picker is displayed during Edit Mode, to make it easy to jump to a specific year.
  • Year Picker Lower Bound and Year Picker Upper Bound: Sets the upper and lower boundaries of the list of possible years. Options include:
    • “Selected” measures from a date selected on the Date Picker. Increments are 1-10, 20, 30 40, 50, 60, 70, 80, 90, and 100.
    • “Today” measures from the current date. Increments are 1-10, 20, 30 40, 50, 60, 70, 80, 90, and 100.
• Minute Picker Increment: For editable date-time fields, select the minute increments (1, 5, 10, 15, 20, 30) for the displayed Time Picker.

Rendering tab [[]]¶

Conditional rendering allows you to display or hide individual columns, based on defined data conditions.

• Render Conditions: These conditions govern when a column will display.
  • Render if: The Model conditions that must be met to enable the field’s editing.
    • All Conditions are met
    • ANY Conditions are met
    • Custom Logic is met
      • Condition Logic: The custom logic for grouping and applying one or more conditions.
  • If hidden, Model field changes should be: If the field is hidden by conditional rendering, set whether any changes made to this field are saved in the model, or cancelled. Depending on the needs of your org, it could be bad user experience to update fields “behind-the-scenes,” especially when the user may be unaware of they are doing so.
    • Retained in Model (the default)
    • Cancelled
• Enable Conditions: These conditions govern when a displayed column may or may not be edited.
  • Enable if: The model conditions that must be met to enable the field’s editing.
    • All Conditions are met
    • ANY Conditions are met
    • Custom Logic is met
      • Condition Logic: The custom logic for grouping and applying one or more conditions.
  • Message to show when disabled: The message displayed to the end user when they attempt to interact with a disabled field. Appears as a tooltip after the user has hovered over the field for longer than a second.

Basic tab [[]]¶

• Label: The label for the column containing the image.
• Image URL: The URL where the image is hosted. Compatible with merge syntax.
• Alternative Text: Descriptive text about the image that can be used by access/assistive technologies such as screen readers and conforms to Web Accessibility Initiative—Accessible Rich Internet Applications (WAI-ARIA) specifications. This property can be a specific string of text, the merge variables of one or more fields, or a combination of the two. Alt text also increases a search engine’s ability to index the image.
• Column Width: The width of the column. Accepts all standard Skuid sizing measurements.
• Allow Users to Show/Hide Column: When checked, allows users to choose whether to show or hide this specific column through fa-sliders Table Settings.
• Show Column by Default: If Allow Users to Show/Hide Column is marked true, this field determines whether a column is shown or not on page load. For large tables with many columns, consider unchecking this field for discretionary columns to give users more flexibility in the data they wish on page load, and prevent flooding the page with columns.

Rendering tab [[]]¶

Conditional rendering allows you to display or hide the image, based on defined conditions.

Basic tab [[]]¶

• Label: The label for the column containing the button. Type in a label, or use the field picker to use a field name as the column label.
• Button Text: Text for the button. The default label is “New Button.”
• Button Icon: The icon to be included to the button label. Click the field picker to select an icon.
• Column Width: The width of the column. Accepts all standard Skuid sizing measurements.
• Allow Users to Show/Hide Column: Check to allow end users to choose whether to show or hide this specific column through fa-sliders Table Settings
• Show Column by Default: If Allow Users to Show/Hide Column is marked true, this field determines whether a column is shown or not on page load. For large tables with many columns, consider unchecking this field for discretionary columns to give end users more flexibility in the data they wish on page load, and prevent flooding the page with columns.

Actions tab [[]]¶

• Actions:
  • fa-plus-circle Add Action: Click to add actions and set them.
  • Convert to Action Sequence: Click to establish an action sequence.
    • Display Name: Give the sequence a memorable name.
    • Description: Describe the goal or purpose of the sequence.
• Action Types: Use the Action Framework to launch actions from the Queue.

Rendering tab [[]]¶

Conditional rendering allows you to display or hide the button, based on defined data conditions.

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.

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

Photo [[]]¶

Display the records in your list as images by referencing an image field on the data source’s object/entity. Read the Photo View tutorial to learn more.

• Image Source: Specifies what type of location the image will be pulled from. This can come in multiple forms as images can be referenced from a file, an external URL, and so on.
• Image Field: Specifies the field which provides the images to be displayed when the end user is on photo view.
• Label Field: Determines the label applied to the image when it’s displayed in photo view.
• On-Click URL: Specifies where the end user is redirected when the image is clicked. Compatible with merge syntax.
• Default Photo: Sets a default photo if an image field isn’t specified by the user.

Custom [[]]¶

Displays the records using a custom view governed by a JavaScript snippet.

• View Icon: The icon displayed next to the view when a custom view item is added.
• View Label: The name of the custom view, displayed in the views dropdown at runtime.
• View Snippet: A snippet returning an object which defines the custom view.