ToolJet/docs/versioned_docs/version-3.16.0-LTS/tutorial/adding-widget.md

67 lines
2.9 KiB
Markdown
Raw Normal View History

2025-08-04 06:49:49 +00:00
---
id: adding-widget
title: Adding a widget
---
# Adding a widget
To add a widget, navigate to the `Widget manager` on the right sidebar. It will display the list of built-in widgets that can be added to the app. Use the search functionality to quickly find the widget that you want.
<img className="screenshot-full" src="/img/tutorial/adding-widget/widget.png" alt="widget"/>
## Drag and drop a widget
Let's add a `table` widget to the app to show the customer data from the query that we created in the previous steps.
To add a widget, drag and drop the widget to the canvas.
## Resize a widget
The widgets can be resized and repositioned within the canvas.
<img className="screenshot-full" src="/img/tutorial/adding-widget/resize.gif" alt="resize" />
## Adding widgets to Modal
To add a widget to Modal, we need to trigger [Show modal action](/docs/tutorial/actions#available-actions)
:::info
Before triggering `Show modal action` we need to add a modal widget to the canvas.
:::
- Add a `modal widget` to the app
- Trigger the **Show modal action**
- Click on the canvas area for the `Widget manager` sidebar
- Navigate to the Widget manager on the right sidebar and Drag and drop a widget into the Modal
<img className="screenshot-full" src="/img/tutorial/adding-widget/modal.gif" alt="adding-widget" />
## Resize table columns
We can resize the column width using the resize handle of the column.
<img className="screenshot-full" src="/img/tutorial/adding-widget/resize-table-column.gif" alt="resize-table-column" />
## Change widget properties
Click on the widget to open the inspect panel on right sidebar. Here you can change the properties of the widgets. Let's configure the table columns to display the customer data. The display order of columns can be changed by dragging icon near the column name.
<img className="screenshot-full" src="/img/tutorial/adding-widget/inspect-panel.gif" alt="inspect panel" />
## Connecting data with widget
Now we will connect the `data` object of the `fetch customers` query with the table. Click on the table widget to open the inspector on the right sidebar. We can see that the data property of the table has an empty array as the value. The data field, like almost every other field on the editor supports single-line javascript code within double brackets. Variable suggestions will be shown as a dropdown while you type the code in the field.
Let's select the `data` object of the 'postgresql' query.
` {{queries.postgresql1.data}}`
Since we have already run the query in the previous step, the data will be immediately displayed in the table.
<img className="screenshot-full" src="/img/tutorial/adding-widget/table-data.png" alt="table data" />
So far in this tutorial, we have connected to a PostgreSQL database and displayed the data on a table.
:::tip
Read the widget reference of table [here](/docs/widgets/table) for more customizations such as server-side pagination, actions, editing data.
:::