Dropdown component where clicking arrow on the side displays dropdown options
Project description
gradio_clickable_arrow_dropdown
Dropdown component where clicking arrow on the side displays dropdown options
Installation
pip install gradio_clickable_arrow_dropdown
Usage
import gradio as gr
from gradio_clickable_arrow_dropdown import ClickableArrowDropdown
def handle_inputs(reg_dropdown_val, custom_dropdown_val):
res = f"""
Regular dropdown value: {reg_dropdown_val}
Custom dropdown value: {custom_dropdown_val}
"""
return res
choices = ["Option 1", "Option 2", "Option 3"]
demo = gr.Interface(
handle_inputs,
[gr.Dropdown(choices=choices, value=choices[0], filterable=False), ClickableArrowDropdown(choices=choices, value=choices[0], filterable=False)],
gr.Textbox(),
)
if __name__ == "__main__":
demo.launch()
ClickableArrowDropdown
Initialization
name | type | default | description |
---|---|---|---|
choices |
list[str | int | float | tuple[str, str | int | float]]
| None
|
None |
A list of string 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 |
str
| int
| float
| list[str | int | float]
| Callable
| None
|
None |
default value(s) selected in dropdown. If None, no value is selected by default. If callable, the function will be called whenever the app loads to set the initial value of the component. |
type |
"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 |
bool | None
|
None |
if True, multiple choices can be selected. |
allow_custom_value |
bool
|
False |
If True, allows user to enter a custom value that is not in the list of choices. |
max_choices |
int | None
|
None |
maximum number of choices that can be selected. If None, no limit is enforced. |
filterable |
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 |
str | 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. |
info |
str | None
|
None |
additional component description. |
every |
float | None
|
None |
If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute. |
show_label |
bool | None
|
None |
if True, will display label. |
container |
bool
|
True |
If True, will place the component in a container - providing some extra padding around the border. |
scale |
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 |
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 |
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 |
bool
|
True |
If False, component will be hidden. |
elem_id |
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 |
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 |
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. |
Events
name | description |
---|---|
change |
Triggered when the value of the ClickableArrowDropdown changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input. |
input |
This listener is triggered when the user changes the value of the ClickableArrowDropdown. |
select |
Event listener for when the user selects or deselects the ClickableArrowDropdown. Uses event data gradio.SelectData to carry value referring to the label of the ClickableArrowDropdown, and selected to refer to state of the ClickableArrowDropdown. See EventData documentation on how to use this event data |
focus |
This listener is triggered when the ClickableArrowDropdown is focused. |
blur |
This listener is triggered when the ClickableArrowDropdown is unfocused/blurred. |
key_up |
This listener is triggered when the user presses a key while the ClickableArrowDropdown is focused. |
User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
- When used as an Input, the component only impacts the input signature of the user function.
- When used as an output, the component only impacts the return signature of the user function.
The code snippet below is accurate in cases where the component is used as both an input and an output.
- As output: Is passed, passes the value of the selected dropdown choice as a
str | int | float
or its index as anint
into the function, depending ontype
. Or, ifmultiselect
is True, passes the values of the selected dropdown choices as a list of correspoding values/indices instead. - As input: Should return, expects a
str | int | float
corresponding to the value of the dropdown entry to be selected. Or, ifmultiselect
is True, expects alist
of values corresponding to the selected dropdown entries.
def predict(
value: str
| int
| float
| list[str | int | float]
| list[int | None]
| None
) -> str | int | float | list[str | int | float] | None:
return value
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for gradio_clickable_arrow_dropdown-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c293b57398d09c8f6e29b22b4681a1bb9b109be0c861f75820533bd7605bfab7 |
|
MD5 | fd454ed01e265d2f1ad00fe523ab61c6 |
|
BLAKE2b-256 | a50e24333f138d9002026f30ddfcbd458c8d1e4dbf556ca1e55eb55399ec8dd6 |
Close
Hashes for gradio_clickable_arrow_dropdown-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20853c10d424c2eaed362f836ad51439c9defd61d40d90b0d7ae28c3e15c11be |
|
MD5 | aeef798634c9c1c682ac58f4935d6b78 |
|
BLAKE2b-256 | c5be038d71a1474291478cfb2fb2aaf53549d1dc451d57e908bd9b78a8161364 |