file_selector

Allows uploading a file content.

The upload can be triggered by pressing a button, or drag-and-dropping a file on top of the control.

Properties

Name	Type	Default	Description
content(★)	str dynamic		The path or the list of paths of the uploaded files.
label	str		The label of the button.
on_action	Union[str, Callable]		A function or the name of a function that will be triggered. This function is invoked with the following parameters: state (State): the state instance. id (str): the identifier of the button if it has one. payload (dict): a dictionary that contains the key "action" set to the name of the action that triggered this callback.
multiple	bool	False	If set to True, multiple files can be uploaded.
extensions	str	".csv,.xlsx"	The list of file extensions that can be uploaded.
drop_message	str	"Drop here to Upload"	The message that is displayed when the user drags a file above the button.
notify	bool	True	If set to False, the user won't be notified of upload finish.
width	Union[str,int]	None	The width of the element.
active	bool dynamic	True	Indicates if this component is active. An inactive component allows no user interaction.
id	str		The identifier that is assigned to the rendered HTML component.
properties	dict[str, Any]		Bound to a dictionary that contains additional properties for this element.
class_name	str dynamic		The list of CSS class names that are associated with the generated HTML Element. These class names are added to the default taipy-file_selector class name.
hover_text	str dynamic		The information that is displayed when the user hovers over this element.

^(★)content is the default property for this visual element.

Usage

Default behavior

The variable specified in content is populated by a local filename when the transfer is completed.

Definition

MarkdownHTMLPython

<|{content}|file_selector|>

<taipy:file_selector>{content}</taipy:file_selector>

import taipy.gui.builder as tgb
...
tgb.file_selector("{content}")

Standard configuration

The label property can be set to a label shown besides the standard icon.
The function name provided as on_action is called when the transfer is completed.
The extensions property can be used as a list of file name extensions that is used to filter the file selection box. This filter is not enforced: the user can select and upload any file.
Upon dragging a file over the button, the value of the drop_message property is displayed as a temporary label for the button.

Definition

MarkdownHTMLPython

<|{content}|file_selector|label=Select File|on_action=function_name|extensions=.csv,.xlsx|drop_message=Drop Message|>

<taipy:file_selector label="Select File" on_action="function_name" extensions=".csv,.xlsx" drop_message="Drop Message">{content}</taipy:file_selector>

import taipy.gui.builder as tgb
...
tgb.file_selector("{content}", label="Select File", on_action=function_name, extensions=".csv,.xlsx", drop_message="Drop Message")

Multiple files upload

The user can transfer multiple files at once by setting the multiple property to True.

Definition

MarkdownHTMLPython

<|{content}|file_selector|multiple|>

<taipy:file_selector multiple>{content}</taipy:file_selector>

import taipy.gui.builder as tgb
...
tgb.file_selector("{content}", multiple=True)

Styling

All the file selector controls are generated with the "taipy-file-selector" CSS class. You can use this class name to select the file selector controls on your page and apply style.

Stylekit support

The Stylekit provides a specific class that you can use to style file selectors:

• fullwidth
  If a file selector uses the fullwidth class, then it uses the whole available horizontal space.