https://github.com/genieframework/stippledownloads.jl
Donwload dynamically generated files with Stipple apps
https://github.com/genieframework/stippledownloads.jl
Last synced: over 1 year ago
JSON representation
Donwload dynamically generated files with Stipple apps
- Host: GitHub
- URL: https://github.com/genieframework/stippledownloads.jl
- Owner: GenieFramework
- License: mit
- Created: 2023-11-30T21:48:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T23:11:22.000Z (over 1 year ago)
- Last Synced: 2025-02-22T11:17:01.107Z (over 1 year ago)
- Language: Julia
- Size: 28.3 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StippleDownloads
StippleDownloads is a plugin for Stipple to enable download of dynamically generated files.
The event-based handlers guarantee that only the requesting client receives a copy of the file.
There is support for text and binary files, filenames can be freely chosen.
## Examples
**Downloading a variable's content as raw data or as BSON**
```julia
using Stipple, Stipple.ReactiveTools
using StippleUI, StippleDownloads
using BSON
@app begin
@in data = randn(1000)
@event download_raw begin
download_binary(__model__, data, "raw")
end
@event download_bson begin
# calling @save on `data` throws an error because it is a reactive variable. Need to make a copy
data_var = data
io = IOBuffer()
BSON.@save io data_var
seekstart(io)
download_binary(__model__, take!(io), "data.bson")
end
end
function ui()
row([
cell(btn(class="q-ml-lg", "Raw", icon="download", @on(:click, :download_raw, :addclient), color="primary", nocaps=true))
cell(btn(class="q-ml-lg", "BSON", icon="download", @on(:click, :download_bson, :addclient), color="secondary", nocaps=true))
])
end
@page("/", ui)
```
**Downloading a DataFrame as an Excel sheet**
```julia
using Stipple, Stipple.ReactiveTools
using StippleUI
using StippleDownloads
using DataFrames
using XLSX
import Stipple.opts
import StippleUI.Tables.table
function df_to_xlsx(df)
io = IOBuffer()
XLSX.writetable(io, df)
take!(io)
end
@app begin
@out table = DataTable(DataFrame(:a => rand(1:10, 5), :b => rand(1:10, 5)))
@in text = "The quick brown fox jumped over the ..."
@event download_text begin
download_text(__model__, :text)
end
@event download_df begin
try
download_binary(__model__, df_to_xlsx(table.data), "file.xlsx"; client = event["_client"])
catch ex
println(ex)
end
end
end
function ui()
row(cell(class = "st-module", [
row([
cell(textfield(class = "q-pr-md", "Download text", :text, placeholder = "no output yet ...", :outlined, :filled, type = "textarea"))
cell(table(class = "q-pl-md", :table))
])
row([
cell(col = 1, "Without client info")
cell(btn("Text File", icon = "download", @on(:click, :download_text), color = "primary", nocaps = true))
cell(col = 1, "With client info")
cell(btn(class = "q-ml-lg", "Excel File", icon = "download", @on(:click, :download_df, :addclient), color = "primary", nocaps = true))
])
]))
end
@page("/", ui)
up(open_browser = true)
```
To see the difference between calling with or without client info, duplicate the applications's tab and click the 'Download Text' button.
Two identical files will be downloaded, because duplicating the tab establishes a synchronised copy of your app. To ensure that only the requesting client receives a file, you should restrict the download to the client via `event["_client"]`
and make sure that the triggering button has an additional `:addclient` to include this information.
