The Table Widget helps us visualize rows of information that are returned from our data sources. We make use of the Table Data property to display data in the table.

Pagination

Tables are generally required to display large data sets from Queries and APIs yet browsers cannot load all the data present in our database. To paginate this data, we can

1. Enable the serverside pagination property in the table

2. Call the API/Query onPageChange

3. Configure pagination in the API/Query

Offset based Pagination

This method uses the Table's page number to determine the offset of the records to fetch from the database. This method relies on the pageNo and pageSize fields of the Table and is used in both APIs and Queries.

The pageNo and pageSize can be used in the Query/API by referencing them inside {{ }}

Select * from users limit {{ Table1.pageSize }} offset {{ (Table1.pageNo - 1) * Table1.pageSize }}

https://mock-api.appsmith.com/users?page={{Table1.pageNo}}

Key Based Pagination

This method uses a value in the response of the API as the key to the next API call. This can be configured in the API settings by providing the Next & Previous URLs that the API should execute onPageChange.

Server-Side Searching / Filtering

Tables come with client-side searching, and filtering out of the box. To perform these operations server-side, we have to pass these values to the API / Query.

Searching

1. Call the API / Query onSearchTextChange from the Table

2. Pass the value of the Table's searchText to the API / Query

select * from users where name ilike '%{{Table1.searchText}}%'

https://mock-api.appsmith.com/users?name={{Table1.searchText}}

Filtering

Server-side filtering requires us to use another widget like a dropdown which can provide users a list of filters that our APIs support.

1. Drag a dropdown and populate it with filter values

2. Call the API / Query onOptionChange from the Table

3. Pass the value of the Dropdown's selectedOptionValue to the API / Query

select * from users where gender = '{{genderDropdown.selectedOptionValue}}'

https://mock-api.appsmith.com/users?gender={{genderDropdown.selectedOptionValue}}

Transforming Table Data

Some API / Query responses might have nested, unnecessary, or poorly formatted fields. These can be easily transformed inside the table data property by mapping over the data using javascript.

Example Github API

https://api.github.com/repos/appsmithorg/appsmith/issues

Binding this APIs response directly to a table would be unreadable like the image below

To format this data, we can simply write a map function over the API response and return an array of objects with only the fields we want to display. We can also format these fields how we'd like using javasript

{{ fetch_issues.data.map((issue) => { 
		return { 
			user: issue.user.login, 
			assignees: issue.assignees.map((assignee) => assignee.login).join(','),
			title: issue.title, 
			number: "#"+issue.number  
			} 
		})
}}