choices |
```python
Sequence[
str | int | float | tuple[str, str | int | float]
]
| None
```
|
None |
a list of string or numeric options to choose from. An option can also be a tuple of the form (name, value), where name is the displayed name of the dropdown choice and value is the value to be passed to the function, or returned by the function. |
value |
```python
str
| int
| float
| Sequence[str | int | float]
| Callable
| DefaultValue
| None
```
|
value = |
the value selected in dropdown. If `multiselect` is true, this should be list, otherwise a single string or number from among `choices`. By default, the first choice in `choices` is initally selected. If set explicitly to None, no value is initally selected. If a function is provided, the function will be called each time the app loads to set the initial value of this component. |
type |
```python
Literal["value", "index"]
```
|
"value" |
type of value to be returned by component. "value" returns the string of the choice selected, "index" returns the index of the choice selected. |
multiselect |
```python
bool | None
```
|
None |
if True, multiple choices can be selected. |
allow_custom_value |
```python
bool
```
|
False |
if True, allows user to enter a custom value that is not in the list of choices. |
max_choices |
```python
int | None
```
|
None |
maximum number of choices that can be selected. If None, no limit is enforced. |
filterable |
```python
bool
```
|
True |
if True, user will be able to type into the dropdown and filter the choices by typing. Can only be set to False if `allow_custom_value` is False. |
label |
```python
str | I18nData | None
```
|
None |
the label for this component, displayed above the component if `show_label` is `True` 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 corresponds to. |
info |
```python
str | I18nData | None
```
|
None |
additional component description, appears below the label in smaller font. Supports markdown / HTML syntax. |
help |
```python
str | I18nData | None
```
|
None |
A string of help text to display in a tooltip next to the label. |
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 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. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. |
min_width |
```python
int
```
|
160 |
minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
interactive |
```python
bool | None
```
|
None |
if True, choices in this dropdown will be selectable; if False, selection will be disabled. If not provided, this is inferred based on whether the component is used as an input or output. |
visible |
```python
bool
```
|
True |
if False, component will be hidden. |
elem_id |
```python
str | None
```
|
None |
an optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
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. Can be used for targeting CSS styles. |
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 |
None |
preserved_by_key |
```python
list[str] | str | None
```
|
"value" |
None |
