Available on SaaS with FlowX.AI . This feature is live on managed (SaaS) deployments now. Self-hosted deployments receive it with the next LTS release.
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, files stored in the Documents plugin keep their original file name. - 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.
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 offers a single Download action on click, added in the component’s Event Handlers section. The File source select determines where the file comes from:- Media Library: Serve a PDF document from the project’s Media Library — pick one with Select from Media Library or add a new one with Upload to Media Library.
- Process Data (in a process) / Local Variables (in a UI Flow): Point to the data key where the document reference is found — for example, the output of an upload action or a document-generation node. In a UI Flow, an additional Location select declares whether the key holds a URL or a Document plugin reference.
- Static: A fixed URL of the document.
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.
Styling
The Download component renders as a button and reuses button styling: a Type (defaultghost), an optional Icon with configurable position, and valid CSS properties per platform. For more information, see the styling documentation.
Platform support
Configured in the FlowX Designer, with runtime support on the web and Android renderers.Related resources
File preview
Preview file contents inside a UI without opening the file
Multiple file upload
Let users upload one or more files from a rendered app