A custom component that toggles between on and off states. Ideal for intuitive user controls and dynamic input handling in machine learning models and data presentations.
Project description
gradio_toggle
A custom component that toggles between on and off states. Ideal for intuitive user controls and dynamic input handling in machine learning models and data presentations.
Installation
pip install gradio_toggle
Usage
import gradio as gr
from gradio_toggle import Toggle
toggle_value = False
toggle_message = ""
def toggle_action(toggle_value):
if toggle_value == False:
toggle_message = "Toggle is False 👎"
elif toggle_value == True:
toggle_message = "Toggle is True 👍"
else:
toggle_message = "Error 😢"
return toggle_message
with gr.Blocks() as demo:
with gr.Row():
with gr.Column():
input = Toggle(label="Input", value=toggle_value, show_label=True, info="This is a toggle button.")
with gr.Column():
output = gr.Label(label="Output")
input.change(fn=toggle_action, inputs=input, outputs=output)
if __name__ == "__main__":
demo.launch()
Toggle
Initialization
name | type | default | description |
---|---|---|---|
value |
bool | Callable
|
False |
Initial state of the toggle. If a callable is provided, it sets the initial state dynamically. |
label |
str | None
|
None |
Text label displayed adjacent to the toggle. Useful for providing context. |
info |
str | None
|
None |
Additional information or instructions displayed below the toggle. |
every |
float | None
|
None |
If value is a callable, this defines how often (in seconds) to refresh the toggle's state. |
show_label |
bool | None
|
None |
Controls the visibility of the label. |
container |
bool
|
True |
None |
scale |
int | None
|
None |
Adjusts the size of the toggle relative to adjacent components. |
min_width |
int
|
75 |
Minimum width of the toggle in pixels. Ensures readability and usability. |
interactive |
bool | None
|
None |
Enables or disables user interaction with the toggle. |
visible |
bool
|
True |
Controls the visibility of the toggle on the interface. |
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 |
Determines if the toggle is rendered immediately in the Blocks context. |
Events
name | description |
---|---|
change |
Triggered when the value of the Toggle 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 Toggle. |
select |
Event listener for when the user selects or deselects the Toggle. Uses event data gradio.SelectData to carry value referring to the label of the Toggle, and selected to refer to state of the Toggle. See EventData documentation on how to use this event data |
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 status of the checkbox as a
bool
. - As input: Should return, expects a
bool
value that is set as the status of the toggle.
def predict(
value: bool | None
) -> bool | 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
gradio_toggle-0.0.2.tar.gz
(41.2 kB
view hashes)
Built Distribution
Close
Hashes for gradio_toggle-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f02bc25fb1dba86f697e2b199c573c3959e8894b4d32ef32dac8891bda848eb |
|
MD5 | e5983d699882ebcf5c8020e63c25ee20 |
|
BLAKE2b-256 | a3dc4fe098704ed0897c6c3417f4a1bd4b897e47dd92ead01ffd6fee3bac6f9e |