Event History List

Label

label

Text

Text to display as the list label.

Label Position

labelPosition

Text

Determines where the label appears. Valid values:

• ABOVE (default) Displays the label above the component.
• ADJACENT Displays the label to the left of the component.
• COLLAPSED Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
• JUSTIFIED Aligns the label alongside the component starting at the edge of the page.

Instructions

instructions

Text

Supplemental text about this list.

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Empty List Message

emptyListMessage

Text

Text to display in the list when no data is available. Default is "No events to display".

Event Data

eventData

List of Event Data

The record event data that populates the list, created using one or more instances of a!eventData().

Event Style

eventStyle

Text

Determines how the component displays. Valid values: "PREVIEW_LIST" (default), "FULL_LIST", "TIMELINE", “LIST_WITH_COMMENTS”. The "PREVIEW_LIST", "FULL_LIST", and "LIST_WITH_COMMENTS" styles are sometimes referred to collectively as list styles. See the UX Design System for best practices on when to use which style.

Date Display

formatTimestamp

Text

Determines how the component formats the event data timestamp. Valid values include: "NULL", "DATE", "DATE_TIME" (default), “DATE_TIME_TIMEZONE”.

User Image Style

displayUser

Text

Determines if and how to display user avatars. Valid values include: "NONE", "INITIALS" (default), "IMAGE".

User Color Scheme

displayUserColorScheme

Any Type

If no profile picture is available, determines which color scheme to use for users in the event history list. Valid values: "PARACHUTE" (default), "VIBRANT", "CLASSIC" or define a custom color scheme using a!colorSchemeCustom(). See Chart Color Scheme for color scheme examples.

Preview List Page Size

previewListPageSize

Number (Integer)

The maximum number of rows to display in each page of the initial list when the "PREVIEW_LIST" event style is selected. To set the paging for the View All dialog, see pageSize. Valid values include 1-10. Default: 5.

Page Size

pageSize

Number (Integer)

The maximum number of rows to display in each page of the list when the "FULL_LIST" or "TIMELINE" event style is selected. When the "PREVIEW_LIST" event style is selected, this parameter applies to the list as it appears in the View More dialog. Valid values include 1-100. Default: 10.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Refresh after each user interaction

refreshAlways

Boolean

When true, eventData will be refreshed after each user interaction and each interval refresh. Default: false.

Refresh after record action completes

refreshAfter

List of Text String

Refreshes eventData data each time a specified action completes. Valid values: "RECORD_ACTION".

Refresh after an interval of time

refreshInterval

Number (Decimal)

How often grid data gets refreshed in minutes. When null, eventData will not be refreshed on an interval. Valid values: "0.5", "1", "2", "3", "4", "5", "10", "30", and "60".

Refresh after referenced variable changes

refreshOnReferencedVarChange

Boolean

When true, grid data will be refreshed each time the value of any variable referenced in the eventData parameter is updated. To refresh grid data when another variable that is not used in the eventData parameter changes, use refreshOnVarChange. Default: true.

Refresh after variable changes

refreshOnVarChange

Any Type

Refreshes data each time any of these specific variables change. This allows you to refresh the data when a variable that is not referenced in the eventData parameter is updated. You can define a single variable (for example, refreshOnVarChange: local!var1) or a list of variables (for example, refreshOnVarChange: {local!var1, local!var2}).

User Filters

userFilters

List of Variant

List of user filter references to display, configured using the recordType! domain. For example, recordType!Order.filters.status. You may only reference user filters defined on the record type used for the eventData. This parameter only applies when there is only one instance of a!eventData().

Component Filters

eventFilters

List of Text

Determines which out-of-the-box filters to show. These filters exist only on the component, not on the record type. Use any combination of the following values {"USER", "EVENT_TYPE", "DATE_RANGE"}.

Initially collapse event details

CollapseDetailsByDefault

Boolean

Determines if the event details are collapsed when the interface first loads. Default: true.

Show search box

showSearchBox

Boolean

Determines if the record search box should be shown. Default: true.

Show reverse sort button

showReverseSortButton

Boolean

Determines if the list should include a button to reverse the event data sort. Default: true.

Comment Layout

commentLayout

Text

If top-level comments are enabled, determines whether to display events in a list or card view. Valid values: “LIST”, “CARD” (default).

Mentionable Users

mentionableUsers

Text

If top-level comments are enabled, this constant specifies the group of users who can be mentioned in comments. Mentioned users will receive email notifications when mentioned in comments.

Comment Card Color

commentCardColor

Text

Determines the color applied to the comment background for list and card layouts. Valid values: any valid hex color or "STANDARD" (default).