PlainDownloader

类组件源码

comp = PlainDownloader(
    id: str | Mapping[str, Any],
    url: str,
    loading_state: LoadingState
)

PlainDownloader是简单、原生的React组件。

该组件基于一个临时创建的、指向指定URL的魔术链接实现。

由于PlainDownloader的实现简单地基于HTML标签<a>，故而无法为其配置请求头或者验证信息。

别名

该类可以按以下方式之一获取

import dash_file_cache as dfc


dfc.PlainDownloader
dfc.components.PlainDownloader

组件属性

描述

名称	类型	说明
id	str | Mapping[str, Any]	组件ID。若设置为字典，则该ID用于模式匹配 callback。
url	str	用来访问要下载数据的URL。 每当设置该值时，就会触发一次下载事件。触发事件后，该值会重置为空字符串。
loading_state	LoadingState	Dash的加载状态字典。用户不应手动设置该值。

参数

名称	类型	可交互	可设置	必选	默认值
id	str | Mapping[str, Any]				undefined
url	str				""
loading_state	LoadingState				undefined

• “可交互”指的是，用户交互可以改变该属性、并触发callback。
• “可设置”指的是，透过callback的Output(...)修改该值会产生实际效果。
• “必选”指的是，初始化组件时，必须向组件传递值，否则组件无法初始化。

范例

最小范例

代码

minimal_example_plain_downloader.py

from typing import Optional
import dash
import flask
from dash import html, Output, Input
from dash_file_cache.services.utilities import get_server
from dash_file_cache.components import PlainDownloader


app = dash.Dash("demo")
server = get_server(app)

app.layout = html.Div(
    (html.Button(id="btn", children="Download"), PlainDownloader(id="downloader"))
)


@server.route("/file")
def file():
    resp = flask.Response("test file content", status=200, mimetype="text/plain")
    resp.headers["Content-Disposition"] = "attachment; filename=test.txt"
    return resp


@app.callback(Output("downloader", "url"), Input("btn", "n_clicks"))
def trigger_get_file(n_clicks: Optional[int]):
    if not n_clicks:
        return dash.no_update
    return "/file"


if __name__ == "__main__":
    app.run()

结果

渲染包含一个下载按钮的应用。

按下按钮时，会下载名为text.txt的文件。文件内容为

test file content