Table
A quickstart on using Budibase tables to interact with your data.
The Table component inside Budibase is great for displaying data to users. It's highly configurable, performant and customizable. Most apps built with Budibase involve displaying data within a table, and interacting with that data.
Getting data into a table
To get data into the Table, you need to have the table nested in a Data Provider.
Table Block
Want to quickly load a table with data, plus add search and filter options? Use the Table block instead.
In the Settings Panel you will find a lot of options of customization for the Table component. You can find all the definitions below.
General
There are several general settings for Table, most of which are shared with other components as well.
| Setting | Description |
|---|---|
| Name | The name of the table, which is not visible to the users, but visible in the structure sidebar |
| Data Provider | The provider of data for this table, this most likely is the wrapping component in your structure. |
| Row Count | The number of rows you want to have visible |
| Columns | Configure which columns you want to have displayed. See detailed explanation below |
| Size | Medium or Large font size |
| Quiet | Removes background-colour |
| Compact | Makes all the margins and paddings smaller, allowing for more data on screen at once. |
| Allow row selection | Adds checkboxes in front of rows, allowing your users to select one or more rows. This will enable the {{ <table-name>.Selected rows }} binding.Row selection is only compatible with internal or SQL tables |
Configure columns
When pressing the configure columns setting, you will be shown a modal where you can define which columns you want to display.
By default this screen is empty, but you can press Add all columns to automatically add all columns defined in the data.
If you wish to remove a column, press the X on the right hand side.
Changing column labels
After you've added columns to your table, you can customize the label displayed in the UI. This is great so you don't need to stick with the column name itself. Changing this will reflect in the UI preview as soon as you hit Save.
Sorting columns
In front of every column you can see a small dotted icon, dragging this allows you to reposition the columns in every order you want.
Advanced column customization
Next we're going to look at advanced column customization. You can get to this through the gearwheel behind every column in the Configure columns section.
Pressing this icon, you will be shown a new modal screen with all the advanced options.
Width
The width of every column can be customized here. There are different modes supported here.
| Mode | |
|---|---|
| empty | By default, when the field is left empty, the margins of all columns will automatically adjust to fit the window |
| auto | When typing auto into the screen, the width will adjust based on the widest value of the column |
| custom | A custom mode, which allows you to put any css supported width in here, such as 200px |
Alignment
This setting allows you to align the text. By default left alignment is used, but now you can also select center and right.
Value
The value field allows you to override the value using Bindings. A great example of what you could do here is to convert a cents column to be displayed with currency symbol and decimals. So if you have 499 in your cents column, you could input this in the Value field
$ {{ divide Value 100 }}
Background and Text colour
Then there are the background and text colour fields. They of course go hand-in-hand. When clicking the circle behind the definition, you can pick from predefined colors, or input your own color
Add components to your table
Adding components, such as buttons and links, to your table rows is simple. Adding a button allows you to assign button actions to rows.
On row click
Click Define actions to run Actions on click of a row.
You will be able to use the {{ Clicked row }} Binding to access the object data of the clicked row.
Updated about 2 months ago