Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Component properties for the Case list

Component properties enable you to configure the behavior of the Case list component instance on a third-party website.

Component propertyDescription
Hide headerOption to display header and its components. By default, it shows header.
TitleRequired title of the Case list component.
Hide record countOption switch to show or hide the total number of records on the case list. By default, it shows record count.
Hide searchOption switch to show or hide search button on the header. Use the Hide search option to search the case within the case list.By default, it shows search button.
Show filtersOption to show or hide filter button on the header. Use this option to customize the display of cases according to pre-defined filters.By default, it hides filter button.
Hide refreshOption to show or hide the refresh button the header. Use this option to refresh the case list.By default, it shows a refresh button.
Hide last refreshed textOption to show or hide a message on the header. Use this option to indicate when the last refresh occurred.By default, it shows last refreshed text.
Table

Table from which the cases or tasks shown on the Case list component. By default, this field is set to the Case [sn_customerservice_case] table.

Note: Case list component can show the records from any extended table of case or task table.

Query

Query to filter the case records. The default query shows all cases.

Note: If no query is provided, all case records are displayed in the Case list component. For more information, see Generate an encoded query string through a filter.

ViewDisplay style for the cases inside the component, chosen from the predefined views.
Columns

Display columns from the case or task table. Select Add to add new columns to the case list table.

Select (

Image omitted: edit-new.png
edit icon) to update and select ([Omitted image "icon-remove.png"] Alt text: Remove icon) to remove column from the case list on the column cards.</p>

Note:

  • If both the View and Columns attributes are provided, the fields specified in Columns will be displayed.
  • If the first column is the reference column, selecting on the case record shows the error in the Case View component.
Disable column resizingOption to adjust the column width. By default, column resizing is enabled.
Records per pageOption to show or hide the number of records that appear by default on the case list. The default value is 20.
Hide errorsOption to show or hide error messages for the end user on the third-party website. By default, it shows errors.
Hide when empty

Option to show or hide the component when there are no cases to display. By default, it shows empty list when there are no cases.

Note: This property is honored when the component initially loads. If no matching records are found for searches or query filters afterward, an empty state is shown regardless of the attribute's value.

Related topics

Configure the Case list component instance

Embed the Case list component instance on the third-party website

Event handler in the Case list component

Sample code for the Case list component