> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# File download

> Let end users download a file from a rendered app using the Download component.

The **Download** component renders as a button that downloads a file when the end user clicks it — for example, a generated contract, an uploaded document, or a static form. You configure which file it serves through the component's **Download** action.

![Download component settings and the Add new event handler dialog with Action type Download, Source Media Library and a Document key](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/6.x/download-component.png)

## Configuring a Download component

The component sits in the **Basic** category of the component palette. Drop it inside a container or card — it is available in both process user tasks and UI Flows, on web and mobile layouts, including collection prototypes and headers/footers. It cannot be placed directly inside forms or table cells.

### Properties

* **Label**: The button text. **Default:** `Download`
* **Save-as file name**: Optional file name used when saving the downloaded file (e.g., `MyFile.pdf`); supports `${}` expressions. When left empty, a file read through the **Document Plugin** source (UI Flows) keeps its original file name, and other Documents plugin downloads are saved as `document`.&#x20;
* **Toast notification on success**: Toggle **ON** to show a confirmation toast after the download completes, with a configurable **Success message** (default: `File downloaded`).
* **Toast notification on error**: Toggle **ON** to show a toast when the download fails, with a configurable **Error message** (default: `There was an error downloading the file`).
* **Loading behavior**: **None** or **Overlay**. With **Overlay**, a loading indicator with a configurable **Loading message** (default: `Downloading...`) is shown while the file is being fetched.

> [!NOTE]
>
> The notification and loading options apply to the web renderer. On Android they are not available — the component downloads the file without toasts or a loading overlay.

### Selecting the file to download

The Download component's click actions are added in the component's **Event handlers** section. In a process user task, it offers a single **Download** action. In a UI Flow, it also offers one **Start workflow** action, which becomes available once the component has a **Download** action (until then the option reads "Add a Download action first."). On FlowX.AI 6.0.0, the component offers only the **Download** action in both contexts.

The **Source** select determines where the file comes from, with the same options as [File Preview](https://docs.flowx.ai/6.x/docs/building-blocks/ui-designer/ui-component-types/file-preview.md#file-preview-properties-web):

* **Media Library**: a PDF from the project's Media Library. Pick one with **Select from Media Library** or add one with **Upload to Media Library**.
* **Document Plugin path** (process user tasks): a Documents plugin `downloadPath`, such as the one in an upload or document-generation reply. The renderer adds the Documents plugin base URL, so you don't need a business rule to build the URL.
* **Document Plugin** (UI Flows): the object that contains `downloadPath`, for example an upload reply. When **Save-as file name** is empty, the file keeps its original file name.
* **URL**: a complete, absolute URL.

For **Document Plugin path** and **URL**, **Value type** sets where the value comes from: **Static** for a fixed value, or **Variable** to read it from a data key. **Document Plugin** always reads a data key. Inside a collection prototype, the key resolves against the row the component is rendered in, so every row of a list serves its own file.

With **Document Plugin path**, the file is saved as `document` unless you set **Save-as file name**.

![Download event handler on a File Download component in a process user task, with Source set to Document Plugin path, Value type set to Variable, and Data key set to downloadPath](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/6.x/6.x-file-download-document-plugin-path-process.png)

![Download event handler on a File Download component in a UI Flow, with Source set to Document Plugin and Data key set to downloadPath](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/6.x/6.x-file-download-document-plugin-uiflow.png)

> [!NOTE]
>
> Files stored in the Documents plugin (and FlowX download URLs) are fetched and saved directly with the resolved file name. A plain external URL opens in a new browser tab instead of downloading, and the success/error notifications do not apply to it.

> [!WARNING]
>
> **Serve stored files through this component rather than through a link of your own.** A file held by the Documents plugin is served over the app's authenticated session, and the Download component fetches it that way. A plain browser navigation to the same address sends no credentials, so a link or button wired by hand, or opening the address in a new browser tab, returns an authorization error instead of the file.

### Styling

The Download component renders as a button and reuses button styling: a **Type** (default `ghost`), an optional **Icon** with configurable position, and valid CSS properties per platform. For more information, see the [styling documentation](https://docs.flowx.ai/6.x/docs/building-blocks/ui-designer/ui-designer.md#styles-tab).

## Platform support

Configured in the FlowX Designer, with runtime support on the **web**, **React Native** and **Android** renderers.

## Related resources

> [card] [File preview](https://docs.flowx.ai/6.x/docs/building-blocks/ui-designer/ui-component-types/file-preview.md)
>
> Preview file contents inside a UI without opening the file

> [card] [Multiple file upload](https://docs.flowx.ai/6.x/docs/building-blocks/ui-designer/ui-component-types/multiple-file-upload.md)
>
> Let users upload one or more files from a rendered app


## Related topics

- [Listing stored files](https://docs.flowx.ai/6.x/docs/platform-deep-dive/core-extensions/content-management/documents-plugin/listing-stored-files.md)
- [Converting files](https://docs.flowx.ai/6.x/docs/platform-deep-dive/core-extensions/content-management/documents-plugin/converting-documents-to-different-formats.md)
- [Fill a document template from a workflow and download it](https://docs.flowx.ai/6.x/cookbooks/generate-and-download-a-document.md)
- [FlowX.AI 5.10.0 Release Notes](https://docs.flowx.ai/release-notes/v5.x/v5.10.0-july-2026/v5.10.0-july-2026.md)
- [Send and receive files with Integration Designer endpoints](https://docs.flowx.ai/6.x/docs/platform-deep-dive/integrations/endpoint-file-handling.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.