How to configure Server level pagination in vFlow applications?

vFlow
1

How to configure Server level pagination in vFlow applications

2

Steps to Configure Server-Side Pagination:

  1. Add or Edit a Component
  • Open your vFlow application in the editor.
  • Add a new Table or List component, or edit an existing one where pagination is required.
  1. Enable Server-Side Pagination
  • Navigate to the Properties section of the selected Table/List component.
  • Locate and select the checkbox Server Side Pagination.
  1. Configure Pagination Properties
  • Once Server Side Pagination is enabled, additional configuration fields will become visible. Configure the following properties as required:
    • Items Per Page: Number of records to be displayed per page.
    • Character Limit: Minimum number of characters required to trigger a search.
    • Debounce Time: Specifies the delay (in milliseconds) before triggering the API call.
    • Current Page: current_page Binds the current page number being requested from the server.
    • Search Query: search_query Captures the search input entered by the user.
    • Sort: sort Used to pass sorting information (such as column name and order) to the backend.
    • Total Records: Total number of records available on the server, returned by the API.
    • Data: The data records to display.
  1. Backend/API Considerations
  • Ensure that the backend API supports pagination parameters
  • The API response should return:
    • The data for the requested page.
    • The total record count, which is required to calculate total pages on the UI.
  1. Commit and Deploy the Application
  • After configuring all required fields, save the changes.
  • Commit and Deploy the application to apply the server-side pagination configuration.

For reference, please refer to the release note where Server-Side Pagination was previously introduced, which includes relevant screenshots and configuration highlights.

1 Like