mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 22:17:55 +00:00
11d38325cb
* add app-builder doc updates on Table and themes * breakdown chart docs in two parts and add custom css for headers * update chart example images and add more examples * revamp table component and minor fixes * fix typos * fix table formatting for docusarus v3 * fix filepicker table * create new version * fix grammar and tables
56 lines
1.9 KiB
Markdown
56 lines
1.9 KiB
Markdown
---
|
|
id: generate-file
|
|
title: Generate file
|
|
---
|
|
|
|
# Generate file
|
|
|
|
This action allows you to construct files on the fly and let users download it.
|
|
|
|
## Options
|
|
|
|
| Option | Description |
|
|
|--------|-------------|
|
|
| Type | Type of file to be generated. Types: `CSV`, `Text` and `PDF` |
|
|
| File name | Name of the file to be generated |
|
|
| Data | Data that will be used to construct the file. Its format will depend on the file type, as specified in the following section |
|
|
| Debounce | Debounce field is empty by default, you can enter a numerical value to specify the time in milliseconds after which the action will be performed. ex: `300` |
|
|
|
|
:::tip
|
|
Check how to run **[generate file action using RunJS](/docs/how-to/run-actions-from-runjs/#generate-file)**.
|
|
:::
|
|
|
|
### CSV Data Format
|
|
|
|
To use the `CSV` file format, the data field should contain an array of objects. ToolJet assumes that the keys in each object are the same and represent the column headers of the CSV file.
|
|
|
|
Example:
|
|
|
|
```javascript
|
|
{{
|
|
[
|
|
{ name: 'John', email: 'john@tooljet.com' },
|
|
{ name: 'Sarah', email: 'sarah@tooljet.com' },
|
|
]
|
|
}}
|
|
```
|
|
|
|
Using the above code snippet will generate a CSV file with the following content:
|
|
|
|
```csv
|
|
name,email
|
|
John,john@tooljet.com
|
|
Sarah,sarah@tooljet.com
|
|
```
|
|
|
|
### Text Data Format
|
|
|
|
To use the `Text` file format, the data field should contain a string.
|
|
|
|
If you want to generate a text file based on an array of objects, you need to stringify the data before providing it.
|
|
|
|
For example, if you are using the table component to provide the data, you can enter **`{{JSON.stringify(components.table1.currentPageData)}}`** in the Data field.
|
|
|
|
### PDF data format
|
|
|
|
The PDF data format supports two types of input: either a `string` or an `array of objects`. When using an array of objects, the resulting PDF will display the data in a tabular format with columns and rows. On the other hand, if a string is provided, the generated PDF will consist of plain text.
|