This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

WidgetMessage: tm-download-file

23rd July 2023 at 9:47pm

The download file message causes the current saver module to prompt the user to download the result of parsing a specified template tiddler as a file. It requires the following properties on the event object:

NameDescription
paramTitle of a tiddler to use as a template for the new tiddler
{any other params}Any other parameters are made available as variables within the context of the widget message.

The following variable names have special behaviour:

NameDescription
filenameFilename for the downloaded file (note that this is a hint to the browser, and the actual filename used may be different)

The download file message is usually generated with the ButtonWidget.

The download file message is handled by the TiddlyWiki core SyncMechanism which invokes the current SaverModule.