List Page Component offers a simple List page, compared to CRUD Page Component. List component is available in both Joget Community and Joget Enterprise & Professional editions. You can export all the records in the List to CSV, Excel, XML, and PDF by clicking on the appropriate link at the bottom of the List.

List Menu Properties

Configure List Menu

Figure 2: List Properties



The UI menu label. You can add Font Awesome Icons into your menu labels.

Menu ID

Item link slug. Optional field. Value defined here must be unique to the rest of the UI Menus as the first matching name will be called upon.

Target List to load.

UI Properties

Figure 3: UI Properties


Show Number of Rows In Menu

Show Number of Rows In Menu. Additional query will be performed to return record count every time the UI loads. Items displayed per page depends on the List selected. Please see List Settings for more information.

Button Position
  • Top Left
  • Top Right
  • Bottom Left
  • Bottom Right
  • Top Left & Bottom Left
  • Top Right & Bottom Right
Selection Type
  • Multiple
  • Single
Selector Position
  • Left
  • Right
  • Both left & right
  • No

Custom Header

Custom Header in HTML.

Custom Footer

Custom Footer in HTML.

Advance Properties

Figure 4: Advanced Properties


UI Key Name

This value should correspond to existing list's column name. When set, the list will be filtered using the UI key value.


UI Key Name: claimant

UI Key Value: Admin Admin

Performance Settings

You can configure the Performance settings in this UI Element which allows one to cache existing content for improved performance and loading speed. Read more at Performance Improvement with UI Caching.

Performance & Offline

Cache Settings

Figure 5: Cache Settings




Caching options are:

  • None: No caching.
  • Application: Cache content by application where all users will see the same content.
  • User: Cache by username.
Duration (s)Duration in seconds to cache content, defaults to 20 seconds if applicable.

PWA Offline Settings

Note: PWA Offline support is dependent on the theme used.

Figure 6: PWA Offline Settings



Enable Cache for Offline SupportEnable caching for offline support, usually set for use on mobile browsers.
Cache List Actions (Non post Action)Enable caching for any non-POST list actions (if any) in the List.
Cache all List Links in First PageEnable caching for any List links present in the first page of this UI menu.

Read Progressive Web Application (PWA) for more information.

AJAX & Events

New Feature

This is a new feature in Joget DX 8.

Event Listening

Figure 7: AJAX & Events - Event Listening

Component Object

The object that will be listening for an event.

This field will dynamically show selectable options depending on the page components used. e.g: if there is a page component called manage meeting in the page, it will automatically show up in this field's select box.

Event NameCustom Event Name.
Matched Action 

Action to be listened for.

  • Hide Component
  • Show Component
  • Show and Reload Component
  • Show and Change URL Component Parameters
  • Reload Page
  • Redirect Page
  • Show and Redirect Component
Add row Adds another row for another event

Event Triggering

Figure 8: AJAX & Events - Event Triggering

Event NameCustom Event Name
Trigger Method

The method used to trigger an event.

  • GET Request
  • POST Request
  • Link Clicked
Parameter NameCustom Parameter Name.

Logical Operator to be used in evaluating "Parameter" against "Value"

  • Equals To
  • Not Equals To
  • Greater Than 
  • Greater Than
  • Greater Than or Equals To
  • Less than
  • Less than or equals to
  • Is True
  • Is False
  • Is Empty
  • Is Not Empty
  • Contains
  • In
  • Regex Match
ValueThe value that the Parameter will be compared to.
When Not Match Trigger Event NameEvent Name when/if the logical operation is not satisfied.
Add rowAdd another row for another event.

Related Documentation

  • No labels