file_download class
Allows downloading of a file content.
Methods¶
__init__() ¶
__init__(
content=None,
label=None,
on_action=None,
auto=False,
render=True,
bypass_preview=True,
name=None,
width=None,
active=True,
id=None,
properties=None,
class_name=None,
hover_text=None,
) -> None
Create a new file_download
element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
content |
Union[path,file,URL,ReadableBuffer,None]
|
The content to transfer.
If this property is set to None, that indicates that dynamic content is generated. Please take a look at the examples below for more details on dynamic generation. |
None
|
label |
str
|
The label of the button. |
None
|
on_action |
Union[str, Callable]
|
A function or the name of a function that is triggered when the download is terminated (or on user action if content is None).
|
None
|
auto |
bool
|
If True, the download starts as soon as the page is loaded. |
False
|
render |
bool
|
If True, the control is displayed. |
True
|
bypass_preview |
bool
|
If False, allows the browser to try to show the content in a different tab. |
True
|
name |
str
|
A name proposition for the file to save, that the user can change. |
None
|
width |
Union[str, int]
|
The width of the element. |
None
|
active |
bool
|
Indicates if this component is active. |
True
|
id |
str
|
The identifier that is assigned to the rendered HTML component. |
None
|
properties |
dict[str, Any]
|
Bound to a dictionary that contains additional properties for this element. |
None
|
class_name |
str
|
The list of CSS class names that are associated with the generated HTML Element. |
None
|
hover_text |
str
|
The information that is displayed when the user hovers over this element. |
None
|