value |
```python
str | Path | Callable | None
```
|
None |
The directory path to show as "selected" when the component is first loaded. If a callable is provided, it will be called when the app loads to set the initial value. |
root_dir |
```python
str | Path
```
|
"." |
Path to the root directory from which to browse folders. If not provided, defaults to the current working directory. Raises ValueError if the directory does not exist or is not a directory. |
label |
```python
str | I18nData | None
```
|
None |
The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to. |
every |
```python
Timer | float | None
```
|
None |
Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
inputs |
```python
Component | Sequence[Component] | set[Component] | None
```
|
None |
Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change. |
show_label |
```python
bool | None
```
|
None |
If True, will display the label. |
container |
```python
bool
```
|
True |
If True, will place the component in a container, providing some extra padding around the border. |
scale |
```python
int | None
```
|
None |
Relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. |
min_width |
```python
int
```
|
160 |
Minimum pixel width, will wrap if not sufficient screen space to satisfy this value. |
height |
```python
int | str | None
```
|
None |
The height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. |
max_height |
```python
int | str | None
```
|
500 |
The maximum height of the component. |
min_height |
```python
int | str | None
```
|
None |
The minimum height of the component. |
interactive |
```python
bool | None
```
|
None |
If True, will allow users to select a folder; if False, will only display the folder structure. |
visible |
```python
bool | Literal["hidden"]
```
|
True |
If False, component will be hidden. If "hidden", component will be visually hidden but still exist in the DOM. |
elem_id |
```python
str | None
```
|
None |
An optional string that is assigned as the id of this component in the HTML DOM. |
elem_classes |
```python
list[str] | str | None
```
|
None |
An optional list of strings that are assigned as the classes of this component in the HTML DOM. |
render |
```python
bool
```
|
True |
If False, component will not be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
key |
```python
int | str | tuple[int | str, ...] | None
```
|
None |
In a gr.render, Components with the same key across re-renders are treated as the same component. |
preserved_by_key |
```python
list[str] | str | None
```
|
"value" |
A list of parameters from this component's constructor. If a component is re-rendered with the same key, these parameters will be preserved in the UI. |
